Some general documentation would be helpful

flaresimulations / synthesizer-grids

Scripts for generating synthesizer grids

https://flaresimulations.github.io/synthesizer/grids/grids.html

1 stars 1 forks source link

Some general documentation would be helpful #1

Closed WillJRoper closed 10 months ago

WillJRoper commented 10 months ago

The repo as it stands is a bit of a black box. Where you should anyone find anything? I have no idea beyond open directories and poking.

In the first instance, it would be good for a descriptive README to be added describing the layout and use cases for the code. Ideally, it would be better if some docs also started to be written alongside the developments.

christopherlovell commented 10 months ago

Updated in #13 and #14