phetsims / gene-expression-essentials

An educational simulation about how genes work to create proteins.
GNU General Public License v3.0
4 stars 6 forks source link

add documentation for model and implementation notes #47

Closed jbphet closed 7 years ago

jbphet commented 7 years ago

We generally have two standard documents: model.md that describes how the model works (often used for sharing with users if they ask about how the sim works) and implementation-notes.md (used primarily by developers that need to understand the code). Theses documents should be added. The previous Java documents can probably be leveraged for this.

jbphet commented 7 years ago

I transferred the documentation from the Java simulation and updated it for the JavaScript version. I think this should be sufficient. Closing.