diff options
| author | Julien Deswaef <judeswae@thoughtworks.com> | 2018-04-30 01:51:04 +0300 |
|---|---|---|
| committer | Julien Deswaef <judeswae@thoughtworks.com> | 2018-04-30 01:51:04 +0300 |
| commit | 31a0b2156c748891ca0d18b00349b7647cf1f6b1 (patch) | |
| tree | a4e48c113ad8c78f4c0a0bd2f6c93f0a306e383d /src/doc | |
| parent | 521bdd2f1e30273e23de16f26f538f20edda9b19 (diff) | |
Updates to the README
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/README.md-nobuild | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/doc/README.md-nobuild b/src/doc/README.md-nobuild index 551835e66..0bb82083c 100644 --- a/src/doc/README.md-nobuild +++ b/src/doc/README.md-nobuild @@ -61,7 +61,7 @@ Or add to the `dependencies` in your `component.json`. -## Building on {{ site.forkawesome.name }} +## Building {{ site.forkawesome.name }} **Before you can build the project**, you must first have the following installed: @@ -69,6 +69,7 @@ to the `dependencies` in your `component.json`. - Ruby Development Headers - **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)* - **Windows:** [DevKit](http://rubyinstaller.org/) + - **macOS:** no extra step required - [Bundler](http://bundler.io/) (Run `gem install bundler` to install). - [Node Package Manager (aka. `npm`)](https://docs.npmjs.com/getting-started/installing-node) @@ -85,7 +86,7 @@ Build the web documentation: $ npm run build -Or serve it on a local server on http://localhost:7998/Fork-Awesome/: +Or serve it on a local server on http://localhost:7998: $ npm run dev |