Skip to content

Commit

Permalink
autoformat README files, phetsims/phet-info#216
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Sep 11, 2023
1 parent cb1c323 commit 3e10d50
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Fourier: Making Waves
=============
"Fourier: Making Waves" 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,
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/fourier-making-waves" target="_blank">visit the simulation's web
page</a>.

Expand All @@ -19,10 +19,9 @@ Click here to run "Fourier: Making Waves".</a>
### Documentation

The <a href="https://github.com/phetsims/phet-info/blob/main/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.
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

Expand Down Expand Up @@ -67,8 +66,8 @@ 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.
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

Expand All @@ -80,8 +79,8 @@ modify this URL based on your HTTP port and relative path.)
(1) Change directory to the simulation directory: `cd ../fourier-making-waves`

(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.
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/fourier-making-waves/build/adapted-from-phet/fourier-making-waves_en_adapted-from-phet.html` (
Expand Down

0 comments on commit 3e10d50

Please sign in to comment.