From 1ee9bd2745c4c8295fb7c582b3abca81cf277e4a Mon Sep 17 00:00:00 2001 From: zepumph Date: Mon, 15 Feb 2021 11:47:33 -0900 Subject: [PATCH] update readme from grunt update, https://github.com/phetsims/ratio-and-proportion/issues/351 --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3cb44dfa..6747ce1a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,58 @@ Ratio and Proportion -================ - +============= "Ratio and Proportion" is an educational simulation in HTML5, by PhET Interactive Simulations at the University of Colorado Boulder. +For a description of this simulation, associated resources, and a link to the published version, +visit the simulation's web page. + +### Try it! -*This simulation is under development and has not been published.* +Click here to run "Ratio and Proportion". + + +Screenshot + ### Documentation The PhET Development Overview 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: Developing Interactive Simulations in HTML5 + +Help us improve, create a New Issue + ### License See the LICENSE