|
1 | 1 | Source code for [browsersync.io](http://browsersync.io/)
|
2 | 2 |
|
3 |
| -##Installation |
| 3 | +## Installation |
4 | 4 |
|
5 |
| -To contribute, you'll need to fork this repo & install the following system-wide tools: |
6 |
| - |
7 |
| -1. [NodeJS](http://nodejs.org) - use the installer. |
8 |
| -2. [GulpJS](https://github.com/gulpjs/gulp) - `$ npm install -g gulp` (mac users may need to [fix npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions)) |
| 5 | +To contribute, you'll need to fork this repo & install [Node](https://nodejs.org/download/). |
9 | 6 |
|
10 | 7 | Next, you need to install the *local* development tools
|
11 | 8 |
|
12 | 9 | ```
|
13 | 10 | $ npm install
|
14 | 11 | ```
|
15 | 12 |
|
16 |
| -##Development Server + BrowserSync |
17 |
| -As you can probably imagine, this project actually uses BrowserSync along with Gulp, Crossbow & a few other awesome projects |
| 13 | +## Development Server + Browsersync |
| 14 | + |
| 15 | +As you can probably imagine, this project actually uses [Browsersync](https://github.com/browsersync/browser-sync) along with [gulp.js](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md), [Crossbow](https://github.com/Crossbow-js/crossbow) & a few other awesome projects |
18 | 16 | to make development a joy. To experience the awesomeness, just run the following command
|
19 | 17 |
|
20 | 18 | ```
|
21 |
| -$ gulp |
| 19 | +$ npm start |
22 | 20 | ```
|
23 | 21 |
|
24 | 22 | This will compile & prefix the `SCSS` files into `CSS`, build the Crossbow site once & launch a browser window to view the site.
|
25 | 23 | Any changes made to SCSS files will will be auto-injected via BrowserSync & any changes to Markdown or HTML files will cause
|
26 | 24 | Crossbow to rebuild the site. (in which case, BrowserSync will wait until it's finished & then reload all browsers for you).
|
27 | 25 |
|
28 |
| -##Build |
| 26 | +## Build |
| 27 | + |
29 | 28 | This site is compiled with Crossbow, which means you need to `build` it before any
|
30 | 29 | of your code fixes or typos are displayed on the live site. This is done automatically for you if you
|
31 |
| - use the development environment mentioned above (by running `gulp`) - but if you need to trigger |
| 30 | + use the development environment mentioned above (by running `npm start`) - but if you need to trigger |
32 | 31 | it manually for html changes, run...
|
33 | 32 |
|
34 |
| -```bash |
35 |
| -$ gulp build |
| 33 | +``` |
| 34 | +$ npm run build |
36 | 35 | ```
|
37 | 36 |
|
38 |
| -Once built, commit all the changes and send you PR :) |
| 37 | +Once built, commit all the changes and send you PR :) |
0 commit comments