MicroSim Submission Guidelines
The Easy Way For Newcomers
The quickest way to help us grow content is to just open an Issue on our GitHub Issues page. Put in a short description and all your code. If you are using the p5.js editor you can just paste in a link to your code there. We will take care of the rest.
For Experienced GitHub Users
We prefer you submit a Pull Request to our site. This allows us to test your code and then merge your changes directly into the "sims" directory.
Usability Tips
- Create a new directory for you MicroSim in the docs/sims area
- Copy the Sims Template to get started
- Provide a background in your index.md file
- Include an image of your working MicroSim in the index.md file
- Include a link to your MicroSim html file in the index.md file
- Include a link to the MicroSim running in the p5.js editor
- Include the JavaScript file in your index.md file
- Place the MicroSim controls below your drawing region
- Provide a simple example with just one or two sliders and if appropriate, have a line to an "Advanced" version with multiple sliders
- Use a very light gray or '''aliceblue''' color as the background of your drawing region. Use white as the background for the controls region.