README 2.0 - Githubissues

MatthewRalston / kmerdb

Python bioinformatics CLI for k-mer counts and de Bruijn graphs

https://matthewralston.github.io/kmerdb

Apache License 2.0

12 stars 1 forks source link

README 2.0 #137

Open MatthewRalston opened 5 months ago

MatthewRalston commented 5 months ago

This would be nice alongside of the interface 'update'.

Needs way more modern and updated usage header.

Possibly include schemas

But maybe the new README should just reflect the new UI, metadata, and schemas printed to stdout, along with the logging module changes... maybe an additional

Errors.md

should be produced to describe the various types of errors and what may trigger them. Referring to the Sphinx docstrings where appropriate to recall the TypeErrors, ValueErrors, KeyErrors etc. that may be raised.

MatthewRalston commented 5 months ago

Condense header, leave the "beta" disclaimer under the development subheader, and make usage go before install. Show the primary two workflows (prof-> matrix -> dist., and graph -> assemble) succinctly.

Also, make website links more easily accessible.
Is TOC necessary?
any subheaders missing?
maybe make subcommands headers in usage area link to their own page, with the expanded help and more detailed description?

MatthewRalston commented 5 months ago

Dramatically condense acknowledgements to just that.
usage statement details can be moved to quickstart page.
whole readme needs to feel sleek and modern
usage .gif