-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move supportsDynamicLocales and colorProfiles to simFeatures, phetsim…
- Loading branch information
Showing
1 changed file
with
3 additions
and
72 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,84 +1,15 @@ | ||
| Build a Nucleus | ||
| ============= | ||
| ================ | ||
|
|
||
| "Build a Nucleus" is an educational simulation in HTML5, by <a href="https://phet.colorado.edu/" target="_blank">PhET Interactive Simulations</a> | ||
| at the University of Colorado Boulder. | ||
| For a description of this simulation, associated resources, and a link to the published version, | ||
| <a href="https://phet.colorado.edu/en/simulation/build-a-nucleus" target="_blank">visit the simulation's web page</a>. | ||
|
|
||
| ### Try it! | ||
|
|
||
| <a href="https://phet.colorado.edu/sims/html/build-a-nucleus/latest/build-a-nucleus_en.html" target="_blank">Click here to run "Build a Nucleus".</a> | ||
|
|
||
| <a href="https://phet.colorado.edu/sims/html/build-a-nucleus/latest/build-a-nucleus_en.html" target="_blank"> | ||
| <img src="https://raw.githubusercontent.com/phetsims/build-a-nucleus/master/assets/build-a-nucleus-screenshot.png" alt="Screenshot" style="width: 400px;"/> | ||
| </a> | ||
| *This simulation is under development and has not been published.* | ||
|
|
||
| ### Documentation | ||
| The <a href="https://github.com/phetsims/phet-info/blob/master/doc/phet-development-overview.md" target="_blank">PhET Development Overview</a> is the most complete guide to PhET Simulation | ||
| Development. This guide includes how to obtain simulation code and its dependencies, notes about architecture & design, how to test and build | ||
| the sims, as well as other important information. | ||
|
|
||
| ### Quick Start | ||
| (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/babel.git | ||
| git clone https://github.com/phetsims/bamboo.git | ||
| git clone https://github.com/phetsims/brand.git | ||
| git clone https://github.com/phetsims/build-a-nucleus.git | ||
| git clone https://github.com/phetsims/build-an-atom.git | ||
| git clone https://github.com/phetsims/chipper.git | ||
| git clone https://github.com/phetsims/dot.git | ||
| git clone https://github.com/phetsims/joist.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/phetcommon.git | ||
| git clone https://github.com/phetsims/phetmarks.git | ||
| git clone https://github.com/phetsims/query-string-machine.git | ||
| git clone https://github.com/phetsims/scenery.git | ||
| git clone https://github.com/phetsims/scenery-phet.git | ||
| git clone https://github.com/phetsims/sherpa.git | ||
| git clone https://github.com/phetsims/shred.git | ||
| git clone https://github.com/phetsims/sun.git | ||
| git clone https://github.com/phetsims/tambo.git | ||
| git clone https://github.com/phetsims/tandem.git | ||
| git clone https://github.com/phetsims/twixt.git | ||
| git clone https://github.com/phetsims/utterance-queue.git | ||
| ``` | ||
|
|
||
| (2) Install dev dependencies: | ||
| ``` | ||
| cd chipper | ||
| npm install | ||
| cd ../perennial-alias | ||
| npm install | ||
| cd ../build-a-nucleus | ||
| npm install | ||
| ``` | ||
|
|
||
| (3) Change directory to chipper `cd ../chipper/`, then transpile the code to JavaScript by running `node js/scripts/transpile.js --watch`. This starts a file-watching process | ||
| that will automatically transpile new or changed files. | ||
|
|
||
| (4) In a new terminal/command prompt, start an http-server | ||
|
|
||
| (5) Open in the browser: `http://localhost/build-a-nucleus/build-a-nucleus_en.html` (You will probably need to modify this URL based on your HTTP port and relative path.) | ||
|
|
||
| #### Optional: Build the simulation into a single file | ||
|
|
||
| (1) Change directory to the simulation directory: `cd ../build-a-nucleus` | ||
|
|
||
| (2) Build the sim: `grunt --brands=adapted-from-phet`. It is safe to ignore warnings like `>> WARNING404: Skipping potentially non-public dependency`, | ||
| which indicate that non-public PhET-iO code is not being included in the build. | ||
|
|
||
| (3) Open in the browser: `http://localhost/build-a-nucleus/build/adapted-from-phet/build-a-nucleus_en_adapted-from-phet.html` (You will probably need to modify this URL based on your HTTP port and relative path.) | ||
|
|
||
| ### Get Involved | ||
|
|
||
| Contact us at our Google Group: <a href="http://groups.google.com/forum/#!forum/developing-interactive-simulations-in-html5" target="_blank">Developing Interactive Simulations in HTML5</a> | ||
|
|
||
| Help us improve, create a <a href="http://github.com/phetsims/build-a-nucleus/issues/new" target="_blank">New Issue</a> | ||
|
|
||
| ### License | ||
| See the <a href="https://github.com/phetsims/build-a-nucleus/blob/master/LICENSE" target="_blank">LICENSE</a> |