grg2rsr / seqpeelsort Goto Github PK

per the JOSS checklist, please add community guidelines (can just be a section in the README):

"Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support"

unify, polish text

and add it as a dependency as soon as current master is released (contains fix for the .smr bug)

add links, polish text

upload output of entire run, including benchmark to the gin repository

Would be helpful to have:

• Documentation for the main script SeqPeelSort.py (what arguments does it take, where does it save outputs, etc.). Some of this is stated in the example usage section, but would be good to have separate docs as a reference.
• Documentation for the configuration file(s) that are needed.

could just be a separate docs.md file, or another section in the README.