From 3e10d5031aef8607b2432a390406f92f38f0654b Mon Sep 17 00:00:00 2001 From: Michael Kauzmann Date: Mon, 11 Sep 2023 17:23:46 -0600 Subject: [PATCH] autoformat README files, https://github.com/phetsims/phet-info/issues/216 --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9ecf01b7..a5580621 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Fourier: Making Waves ============= "Fourier: Making Waves" 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, +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. @@ -19,10 +19,9 @@ Click here to run "Fourier: Making Waves". ### 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. +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 @@ -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 @@ -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` (