diff --git a/README.md b/README.md index 144a5f5..468cc6d 100644 --- a/README.md +++ b/README.md @@ -54,63 +54,6 @@ Make sure to read the [Contributing Guide](https://github.com/GoodBoyDigital/pixi.js/blob/master/CONTRIBUTING.md) before submitting changes. -## How to build ## - -Note that for most users you don't need to build this project. If all you want is to use pixi, then -just download one of our [prebuilt releases](https://github.com/GoodBoyDigital/pixi.js/releases). Really -the only time you should need to build pixi.js is if you are developing it. - -If you don't already have Node.js and NPM, go install them. Once you do, you can then install the gulp -executable: - -``` -$> npm install -g gulp -``` - -Then, in the folder where you have cloned the repository, install the build dependencies using npm: - -``` -$> npm install -``` - -Then, to build the source, run: - -``` -$> gulp build -``` - -This will create a minified version at `bin/pixi.min.js` and a non-minified version at `bin/pixi.js` -with all the plugins in the pixi.js project. - -If there are specific plugins you don't want, say "interaction" or "extras", you can exclude those: - -``` -$> gulp build --exclude extras --exclude interaction -``` - -You can also use the short-form `-e`: - -``` -$> gulp build -e extras -e interaction -e filters -``` - -### How to generate the documentation ### - -The docs can be generated using npm: - -``` -$> npm run docs -``` - -There is also a gulp task to generate them if you want to: - -``` -$> gulp jsdoc -``` - -The documentation uses [Jaguar.js](https://github.com/davidshimjs/jaguarjs-jsdoc) and the jsdoc format, the configuration -file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) - ### Current features ### - WebGL renderer (with automatic smart batching allowing for REALLY fast performance) @@ -174,6 +117,63 @@ } ``` +### How to build ### + +Note that for most users you don't need to build this project. If all you want is to use pixi, then +just download one of our [prebuilt releases](https://github.com/GoodBoyDigital/pixi.js/releases). Really +the only time you should need to build pixi.js is if you are developing it. + +If you don't already have Node.js and NPM, go install them. Once you do, you can then install the gulp +executable: + +``` +$> npm install -g gulp +``` + +Then, in the folder where you have cloned the repository, install the build dependencies using npm: + +``` +$> npm install +``` + +Then, to build the source, run: + +``` +$> gulp build +``` + +This will create a minified version at `bin/pixi.min.js` and a non-minified version at `bin/pixi.js` +with all the plugins in the pixi.js project. + +If there are specific plugins you don't want, say "interaction" or "extras", you can exclude those: + +``` +$> gulp build --exclude extras --exclude interaction +``` + +You can also use the short-form `-e`: + +``` +$> gulp build -e extras -e interaction -e filters +``` + +### How to generate the documentation ### + +The docs can be generated using npm: + +``` +$> npm run docs +``` + +There is also a gulp task to generate them if you want to: + +``` +$> gulp jsdoc +``` + +The documentation uses [Jaguar.js](https://github.com/davidshimjs/jaguarjs-jsdoc) and the jsdoc format, the configuration +file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) + ### License ### This content is released under the (http://opensource.org/licenses/MIT) MIT License.