Skip to content

Commit

Permalink
Update README.md files, see phetsims/chipper#1157
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Dec 7, 2021
1 parent 0d90b1c commit 7f55771
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ 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/perennial.git
git clone https://github.com/phetsims/perennial.git perennial-alias
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
Expand All @@ -47,17 +49,27 @@ git clone https://github.com/phetsims/twixt.git
git clone https://github.com/phetsims/utterance-queue.git
```

(2) Change directory to `chipper/`, and install dependencies by running `npm install`
(2) Install dev dependencies:
```
cd chipper
npm install
cd ../perennial
npm install
cd ../perennial-alias
npm install
cd ../ratio-and-proportion
npm install
```

(3) Still in directory `chipper/`, transpile the code to JavaScript by running `node js/scripts/transpile.js` (or add `--watch` to enable a file watching process)
(3) Change directory to chipper `cd ../chipper/`, then transpile the code to JavaScript by running `node js/scripts/transpile.js --watch`

(4) Start an http-server

(5) Open in the browser: `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.)

#### Optional: Build the simulation into a single file

(1) Change directory to the simulation directory: `cd ratio-and-proportion`
(1) Change directory to the simulation directory: `cd ../ratio-and-proportion`

(2) Build the sim: `grunt --brands=adapted-from-phet`

Expand Down

0 comments on commit 7f55771

Please sign in to comment.