search

Arcadia-Science / noveltree

NovelTree is a highly parallelized and computationally efficient phylogenomic workflow that infers gene families, gene family trees, species trees, and gene family evolutionary history.
GNU Affero General Public License v3.0
17 stars 3 forks source link

Ap/readmes #78

Closed austinhpatton closed 1 year ago

austinhpatton commented 1 year ago

Alrighty, I think I've done all we can for this README!

Lots and lots of stuff here, and again, I agree that we'll eventually probably want to make sub-pages that are easily navigable, but for now I think the fact that we can collapse different sections should at the very least help to minimize overload (at least some).

Let me know if you think there's anything i'm missing - we might just be able to get rid of that little checklist at the very end of the readme.

elizabethmcd commented 1 year ago

Just doing a quick driveby on this - are you able to split some of the README into docs/usage.md and docs/output.md similar to our other Nextflow workflows? (See the reads2genome docs for example: https://github.com/Arcadia-Science/reads2genome/tree/main/docs). We usually do this for a v1 of our other workflows and especially for a complex one like this it could help a lot