search

ritagnunes / PulseqDiffusion

GNU Affero General Public License v3.0
9 stars 3 forks source link

[JOSS] Functionality documentation missing #6

Open mathieuboudreau opened 4 years ago

mathieuboudreau commented 4 years ago

Hi,

Per the JOSS guidelines, your should provide the following:

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

I can't seem to find anywhere (readme, wiki, readthedocs, etc), where the core functionality of your software is documented. Am I not looking in the right place?

ritagnunes commented 4 years ago

Documentation can be generated by compiling the Sphinx documents provided under the docs folder. I have edited the README.md file to explicitly explain how this can be achieved (commit ad5b083).