There is a choice to be made in how to best document everything. In the end, all reasonable functionality should be contained within the README (as you are already doing). But I suspect that a more complete spec characterization (ie including figures and tables) might be better served by a separate doc of some type. This is particularly true if we plan to write this up for some journal. We should think about a reasonably easy documenting system (that maps over to latex easily).
Also, I'd like to see a guide for actually setting up the build environment as well. If it's fairly simple, adding to the README is fine.
dihm
commented
1 year ago
There is a choice to be made in how to best document everything. In the end, all reasonable functionality should be contained within the README (as you are already doing). But I suspect that a more complete spec characterization (ie including figures and tables) might be better served by a separate doc of some type. This is particularly true if we plan to write this up for some journal. We should think about a reasonably easy documenting system (that maps over to latex easily).
Also, I'd like to see a guide for actually setting up the build environment as well. If it's fairly simple, adding to the README is fine.