search

murphyqm / pytesimal

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

Write documentation #26

Closed murphyqm closed 3 years ago

murphyqm commented 3 years ago

Add simple documentation, installation instructions, example cases.

murphyqm commented 3 years ago

The markdown linter requested an indented as opposed to fenced code block; not sure why it had a preference given that fenced gets more precedence on github markdown docs.

murphyqm commented 3 years ago

Need to find a linter/formatter for Markdown if I'm going to be writing more extensive docs (and the software paper) because waiting for the github linter to tell me something wrong isn't the most efficient!!