Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c22e849

Browse files
committedMar 21, 2015
Merge branch 'master' of github.com:processing-js/processing-js
2 parents 811dafe + b25bab3 commit c22e849

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed
 

‎README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
Processing.js
2-
=============
1+
# Processing.js
32

4-
This is the compilation repository for Processing.js, building the processing.js library from a series of modules, rather than existing as one large file as was the case in version 1.4.1 and earlier.
3+
For the project website, visit http://processingjs.org
54

6-
**note:** this is not the repository for Processing, the language and IDE. Processing itself is hosted over at https://github.com/processing/processing.
5+
This is the compilation repository for Processing.js, used in building the `processing.js` library from a series of Node.js flavoured commonjs modules, rather than existing as one large file as was the case in all versions up to and including 1.4.1 (released august 2012) .
76

8-
Getting Processing.js
9-
---------------------
7+
The current version is 1.4.13 (released March 21, 2015)
8+
9+
**note:** this is not the repository for Processing, the language and IDE. Processing itself is hosted over at https://github.com/processing/processing. This is also not where to file bugs or ask questions about the "JS mode" that can be used with Processing, that project is hosted over at https://github.com/fjenett/javascript-mode-processing
10+
11+
## Getting Processing.js
12+
13+
### Bower install
14+
15+
`bower install processing`
16+
17+
### NPM install
18+
19+
`npm install processing-js`
20+
21+
### Getting Processing.js the plain way
1022

1123
Simply grab the `processing.js` or `processing.min.js` files, include them as script on your webpage, and you're all set. See `test.html` for a simple example of using Processing.js on your pages.
1224

13-
Playing with the code
14-
---------------------
25+
## Playing with the code
1526

1627
Clone this project using git, and ensure you have [node.js](http://nodejs.org) installed. After cloning, install the require node packages using `npm install` in the processing-js directory. Modifying the code and building your own `processing.js` and `processing.min.js` files is then a fairly straight forward process. Modify the code as much as you want or need, then:
1728

@@ -28,15 +39,16 @@ The test script also accepts the following optional arguments:
2839
* `--noref` will not start a server process and a browser for doing ref testing.
2940
* `--noautoref` will start a server and a browser for ref testing, but doesn't auto-start the tests.
3041

42+
### Manual operations
43+
3144
You can also perform the post-unit-test steps manually:
3245

3346
* Build processing.js: `$> browserify build.js -o processing.js`
3447
* Minify processing.js: `$> node minify`
3548
* Run test server: `$> node server`
3649

3750

38-
While the browser tests run
39-
---------------------------
51+
### While the browser tests run
4052

4153
With the test server is running, the following urls are good to know:
4254

0 commit comments

Comments
 (0)
Please sign in to comment.