Skip to content

Commit 18e4cfe

Browse files
committed
build: do not require global gulp command
Now contributors don’t need to install `gulp` globally.
1 parent d835eed commit 18e4cfe

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
"version": "0.0.1",
44
"description": "The Browsersync website",
55
"scripts": {
6+
"start": "gulp",
7+
"build": "gulp build",
68
"test": "gulp build"
79
},
810
"author": "Shane Osbourne",
911
"contributors": [
1012
"Shinnosuke Watanabe (https://github.com/shinnn)"
1113
],
12-
"homepage": "https://github.com/BrowserSync/website",
14+
"homepage": "https://github.com/BrowserSync/browsersync.github.io",
1315
"repository": "BrowserSync/browsersync.github.io",
1416
"license": "ISC",
1517
"private": true,

readme.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
11
Source code for [browsersync.io](http://browsersync.io/)
22

3-
##Installation
3+
## Installation
44

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/).
96

107
Next, you need to install the *local* development tools
118

129
```
1310
$ npm install
1411
```
1512

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
1816
to make development a joy. To experience the awesomeness, just run the following command
1917

2018
```
21-
$ gulp
19+
$ npm start
2220
```
2321

2422
This will compile & prefix the `SCSS` files into `CSS`, build the Crossbow site once & launch a browser window to view the site.
2523
Any changes made to SCSS files will will be auto-injected via BrowserSync & any changes to Markdown or HTML files will cause
2624
Crossbow to rebuild the site. (in which case, BrowserSync will wait until it's finished & then reload all browsers for you).
2725

28-
##Build
26+
## Build
27+
2928
This site is compiled with Crossbow, which means you need to `build` it before any
3029
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
3231
it manually for html changes, run...
3332

34-
```bash
35-
$ gulp build
33+
```
34+
$ npm run build
3635
```
3736

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

Comments
 (0)