scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2024-12-28 17:02:24 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation about building, editing and testing code.

Browse source
This commit is contained in:
Jürg Lehni 2011-06-25 08:53:52 +01:00
parent 6e38d855ac
commit 0f8e0f2c81
1 changed files with 46 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -39,10 +39,55 @@ If you are working with a fork and would like to fetch from upstream, run
git fetch upstream
To update the `jsdoc-toolkit` submodule inside the `build` directory, used to generate the documentation, run
To update the `jsdoc-toolkit` submodule inside the `build` folder, used to generate the documentation, run
git submodule update --init
### Building Library
The Paper.js sources are distributed across many separate files, organised in subfolders inside the `src` folder. To compile them all into one distributable file, yo need to run the `build.sh` script inside the `build` folder:
cd build
./build.sh
You will then find the built library inside the `dist` folder, named `paper.js`.
`build.sh` offer a row of modes:
commented Preprocessed but still formated and commented
stripped Formated but without comments (default)
compressed No comments and no whitespaces
uglified Uses UglifyJS to further reduce file size
In order for UglifyJS to work when building Paper.js, it needs to be located in a folder name `uglifyjs` on the same level as your `paper.js` project folder. Alternatively you can also adjust the path in `build/preprocess.sh`
### Building Documentation
Similarly to building the library, you can run `docs.sh` inside the `build` folder to build the documentation.
cd build
./build.sh
Your docs will then be located at `dist/docs`.
### Editing and Running Code during Development
As a handy alternative to building the library after each change to try it out in your scripts, there is a helper script `src/load.js` that loads the library directly from all the separate source files in the `src` folder. The shell script `load.sh` in the `build` folder produces a `paper.js` library in `dist` that does nothing else than loading the source files through `src/load.js`. This means you can switch between loading from sources and loading a built library simply by running `build.sh` or `load.sh` inside the `build` folder.
cd build
./load.sh
And to go back to a built library
cd build
./build.sh
Note that your PaperScripts examples do not need to change, they can simply load `dist/paper.js`, which will always do the right rhing.
### Testing
Paper.js is developed and tested from day 1 with proper unit testing. To run the tests after any change to the library's source, simply open `index.html` inside the `test` folder in your web browser.
### Contributing
The main Paper.js source tree is hosted on git (a popular [DVCS](http://en.wikipedia.org/wiki/Distributed_revision_control)), thus you should create a fork of the repository in which you perform development. See <http://help.github.com/forking/>.