Skip to content

Commit

Permalink
update readme from grunt update, #351
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Feb 15, 2021
1 parent 3ca1932 commit 1ee9bd2
Showing 1 changed file with 46 additions and 3 deletions.
49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,58 @@
Ratio and Proportion
================

=============
"Ratio and Proportion" 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/ratio-and-proportion" target="_blank">visit the simulation's web page</a>.

### Try it!

*This simulation is under development and has not been published.*
<a href="https://phet.colorado.edu/sims/html/ratio-and-proportion/latest/ratio-and-proportion_en.html" target="_blank">Click here to run "Ratio and Proportion".</a>

<a href="https://phet.colorado.edu/sims/html/ratio-and-proportion/latest/ratio-and-proportion_en.html" target="_blank">
<img src="https://raw.githubusercontent.com/phetsims/ratio-and-proportion/master/assets/ratio-and-proportion-screenshot.png" alt="Screenshot" style="width: 400px;"/>
</a>

### 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/brand.git
git clone https://github.com/phetsims/chipper.git
git clone https://github.com/phetsims/dot.git
git clone https://github.com/phetsims/griddle.git
git clone https://github.com/phetsims/joist.git
git clone https://github.com/phetsims/kite.git
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/ratio-and-proportion.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/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) Start an http-server

(3) Open `http://localhost/ratio-and-proportion/ratio-and-proportion_en.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/ratio-and-proportion/issues/new" target="_blank">New Issue</a>

### License
See the <a href="https://github.com/phetsims/ratio-and-proportion/blob/master/LICENSE" target="_blank">LICENSE</a>

0 comments on commit 1ee9bd2

Please sign in to comment.