-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating dot/kite/scenery READMEs with fixed links
- Loading branch information
1 parent
b2cc039
commit 80a2159
Showing
1 changed file
with
37 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,45 @@ | ||
kite | ||
==== | ||
======= | ||
|
||
A library for creating, manipulating and displaying 2D shapes in JavaScript. | ||
kite is a library for creating, manipulating and displaying 2D shapes in JavaScript. | ||
|
||
By PhET Interactive Simulations | ||
https://phet.colorado.edu/ | ||
|
||
### Documentation | ||
See the website with documentation and examples at http://phetsims.github.io/kite/ | ||
Documentation, examples, and downloads are available at http://phetsims.github.io/kite/ | ||
|
||
### To check out and build the code | ||
|
||
Our processes depend on [Node.js](http://nodejs.org/) and [Grunt](http://gruntjs.com/). It's highly recommended to install | ||
Node.js and then grunt with `npm install -g grunt-cli`. | ||
|
||
(1) Clone the simulation and its dependencies: | ||
``` | ||
git clone https://github.com/phetsims/assert.git | ||
git clone https://github.com/phetsims/axon.git | ||
git clone https://github.com/phetsims/chipper.git | ||
git clone https://github.com/phetsims/dot.git | ||
git clone https://github.com/phetsims/kite.git | ||
git clone https://github.com/phetsims/perennial.git perennial-alias | ||
git clone https://github.com/phetsims/phet-core.git | ||
git clone https://github.com/phetsims/sherpa.git | ||
git clone https://github.com/phetsims/tandem.git | ||
``` | ||
|
||
(2) Install dev dependencies: | ||
``` | ||
cd chipper | ||
npm install | ||
cd ../perennial-alias | ||
npm install | ||
cd ../kite | ||
npm install | ||
``` | ||
|
||
(3) Build kite | ||
|
||
Ensure you're in the kite directory and run `grunt --lint=false --report-media=false`. This will output files under the `build/` directory | ||
|
||
### License | ||
See the [license](LICENSE) | ||
|
||
MIT license, see [LICENSE](LICENSE) |