Skip to content

Commit 434976f

Browse files
committed
expanded readme instructions
as per #9
1 parent 7753225 commit 434976f

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,44 @@ The [master](https://github.com/DefinitelyTyped/definitelytyped.github.io/tree/m
66

77
The site build with [Grunt](http://www.gruntjs.com) and generated using [docpad](http://docpad.org), a static site generator complete with watch tasks, development server with LiveReload and [many plugins](http://docpad.org/docs/plugins). Publishing happens using [grunt-gh-pages](https://github.com/tschaub/grunt-gh-pages).
88

9-
109
## How to edit
1110

12-
1. Have the grunt global cli command `$ npm install grunt-cli -g`
11+
Working with the site is done using your commandline terminal and should work on any platform. So it can be bash or shell or cmd.exe or anything else (like WebStorm embedded terminal).
12+
13+
Prerequisites:
14+
15+
1. Get [node.js](http://nodejs.org/) (`> 0.10.0`) for your local platform, it comes with the `npm` package manager.
16+
17+
1. Have the global grunt cli command: run `npm install grunt-cli -g` in your command line.
18+
19+
Get the project
1320

1421
1. Checkout and update the `source` branch.
1522

16-
1. Run `$ npm install` to pull all local dependencies.
23+
1. Run `npm install` to pull all local dependencies. (this can take a minute)
24+
25+
Work in the project
1726

1827
1. Use grunt to execute tasks. The main command are:
1928

20-
1. `$ grunt clean` - drop all generated content.
29+
1. Run `grunt clean` - drop all generated content.
2130

22-
1. `$ grunt watch` - regenerate and start a watch with LiveReload server at [http://localhost:9778/](http://localhost:9778/)
31+
1. Run `grunt watch` - regenerate and start a watch with LiveReload server at [http://localhost:9778/](http://localhost:9778/)
2332

24-
1. `$ grunt build` - regenerate the site for production environment .
33+
1. Run `grunt build` - regenerate the site for production environment .
2534

26-
1. `$ grunt publish` - build and push to github `master` (live at [definitelytyped.github.io](http://definitelytyped.github.io/)). This will ask for your github credentials. You need commit access to the repository. Don't forget to push your `source` branch too!
35+
1. Run `grunt publish` - build and push to github `master` (live at [definitelytyped.github.io](http://definitelytyped.github.io/)). This will ask for your github credentials. You need commit access to the repository. Don't forget to push your `source` branch too!
2736

28-
1. See `$ grunt -h` or the `Gruntfile.js` for additional commands.
37+
1. See `grunt -h` or the `Gruntfile.js` for additional commands.
2938

3039
:warning: Direct changes to `master` branch will be overwritten or discarded so always edit through `source`!
3140

41+
Notes:
42+
43+
1. You don't need a global docpad install, it comes as local dependency.
44+
45+
1. If you build or watch the content then you might get some yellow `warning`'s in the console. These can usually be ignored as it is docpad telling us that some transforms didn't have any effect: this is correct if you use a template transform (`.eco`) but have no template fields in the file (*yet*).
46+
3247
## Contributions
3348

3449
At some point we'll take contributions; it will probably involve sending a Pull Request on the `source` branch.

0 commit comments

Comments
 (0)