doc(clowm): adjust clowm readme - Githubissues

metagenomics / metagenomics-tk

GNU Affero General Public License v3.0

6 stars 1 forks source link

doc(clowm): adjust clowm readme #364

Closed pbelmann closed 2 months ago

pbelmann commented 2 months ago

This PR adjusts the clowm related documentation:

Meta-omics-toolkit is renamed to Metagenomics-Toolkit.
A figure with the general workflow schema is added.
General overhaul of the readme and output markdown.
Usage.md now also includes a hint regarding the usage of external but publicly available datasets.

PR review guidelines

Thank you for submitting this PR.

Before merge:

The PR must be reviewed by one of the team members.
Please check if anything in the Readme must be adjusted, or added (development-setup, production-setup, user-guide).
PRs with new modules or workflow interfaces must include tests according to the developer guidelines.
The new code is readable, well commented and should adhere to our developer guidelines.
Before merging it must be checked if a squash of commits is required.