search

murphyqm / pytesimal

Model the conductive cooling of small planetary bodies with temperature-dependent material properties
MIT License
1 stars 0 forks source link

Simple documentation #19

Closed andreww closed 3 years ago

andreww commented 3 years ago

As well as the installation instructions (see #18) it's worth expanding the README file to explain a bit more about what the software does (and does not) do. The Software Sustainability Institute has some general advice about documentation (e.g. here, here and here) but the template at the bottom of this blog post may be the best place to start.

murphyqm commented 3 years ago

Unintentionally closed this issue by merging the branch I had linked it to - I'm reopening as I think more needs to be added.