Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all published README.md files. #1157

Closed
pixelzoom opened this issue Nov 26, 2021 · 22 comments
Closed

Update all published README.md files. #1157

pixelzoom opened this issue Nov 26, 2021 · 22 comments

Comments

@pixelzoom
Copy link
Contributor

Now that TS is in common code, all sims require a compilation step before they can be run. This is not currently reflected in README.md files for published sims.

When updating README.md files, be sure to take #1136 into consideration. Prototypes have a version >= 1.X.X, but should not have a published README.md.

@samreid
Copy link
Member

samreid commented Dec 6, 2021

I updated the template but thought it would be wise to request review before applying it to 100+ repos:

Index: templates/README-published.md
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/templates/README-published.md b/templates/README-published.md
--- a/templates/README-published.md	(revision a777699ffdf0554147a19b45390415eac0d3ff38)
+++ b/templates/README-published.md	(date 1638806796446)
@@ -23,9 +23,22 @@

{{CLONE_COMMANDS}}

-(2) Start an http-server
+
+(2) Change directory to `chipper/`, and install dependencies by running `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)
+
+(4) Start an http-server

-(3) Open `http://localhost/{{REPOSITORY}}/{{REPOSITORY}}_en.html` (You will probably need to modify this URL based on your HTTP port and relative path.)
+(5) Open in the browser: `http://localhost/{{REPOSITORY}}/{{REPOSITORY}}_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 {{REPOSITORY}}`
+
+(2) Build the sim: `grunt --brands=adapted-from-phet`
+
+(3) Open in the browser: `http://localhost/{{REPOSITORY}}/build/adapted-from-phet/{{REPOSITORY}}_en_adapted-from-phet.html` (You will probably need to modify this URL based on your HTTP port and relative path.)

### Get Involved


@pixelzoom @zepumph or @jonathanolson can you please review?

@pixelzoom
Copy link
Contributor Author

The proposed changes in #1157 (comment) look OK to me.

@pixelzoom pixelzoom assigned samreid and unassigned pixelzoom Dec 6, 2021
samreid added a commit to phetsims/area-model-introduction that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/area-builder that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/area-model-multiplication that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/balancing-act that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/area-model-algebra that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/build-a-molecule that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/atomic-interactions that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/circuit-construction-kit-dc that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/bending-light that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/area-model-decimals that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/charges-and-fields that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/blackbody-spectrum that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/circuit-construction-kit-dc-virtual-lab that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/acid-base-solutions that referenced this issue Dec 6, 2021
samreid added a commit to phetsims/molecule-shapes that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/quadrilateral that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/sun that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/vector-addition that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/unit-rates that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/number-line-distance that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/molecule-shapes-basics that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/plinko-probability that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/reactants-products-and-leftovers that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/rutherford-scattering that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/models-of-the-hydrogen-atom that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/projectile-motion that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/vector-addition-equations that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/resistance-in-a-wire that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/pendulum-lab that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/number-play that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/gases-intro that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/ph-scale that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/scenery that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/utterance-queue that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/make-a-ten that referenced this issue Aug 15, 2022
samreid added a commit to phetsims/under-pressure that referenced this issue Aug 15, 2022
@samreid
Copy link
Member

samreid commented Aug 15, 2022

@marlitas and I updated all the readmes as described in the preceding comments. @pixelzoom would you like to review?

@samreid samreid assigned pixelzoom and unassigned samreid Aug 15, 2022
samreid added a commit that referenced this issue Aug 15, 2022
@pixelzoom
Copy link
Contributor Author

pixelzoom commented Aug 22, 2022

I spot-checked a few README.md files. Looks good. Closing.

jbphet pushed a commit to phetsims/greenhouse-effect that referenced this issue Sep 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants