Unified Diff: README.md
Issue 29674571:
Issue 6290 - Add information on getting started to help.eyeo.com README (Closed)
Base URL: https://hg.adblockplus.org/help.eyeo.com
Patch Set:
Created Jan. 19, 2018, 10:03 a.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: README.md |
| =================================================================== |
| --- a/README.md |
| +++ b/README.md |
| @@ -1,9 +1,44 @@ |
| # help.eyeo.com |
| Source code and content of [help.eyeo.com](https://help.eyeo.com). |
| +## Getting started |
| + |
| +**1. Install [CMS](https://github.com/adblockplus/cms)** |
| + |
| +This static site is generated using the Adblock Plus CMS. For more information |
| +and usage instructions see [CMS documentation](https://github.com/adblockplus/cms/blob/master/README.md#content-structure). |
| + |
| +**2. Install [Gulp.js](https://gulpjs.com/) globally** |
| + |
| +Gulp is required to build the static assets from the source files. |
| + |
| +``` |
| +npm install gulp-cli -g |
| +``` |
| + |
| +**3. Install dependencies** |
| + |
| +``` |
| +npm install |
| +``` |
| + |
| +**4. Build static assets** |
| + |
| +``` |
| +gulp |
| +``` |
| + |
| +**5. Run the test server** |
| + |
| +Start the cms test server |
| + |
| +``` |
| +python path/to/cms/runserver.py |
| +``` |
| + |
| ## License |
| - Source code: [GPL-3.0](https://www.gnu.org/licenses/gpl.html) |
| - Content: [CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/) |
| - "Source Sans Pro" Fonts: [SIL Open Font License (2012 Adobe Systems Incorporated)](static/fonts/Source-Sans-Pro-300/LICENSE.txt) |
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
