search

malariagen / vector-tools

Scripts, pipelines, docs to support data production work for MalariaGEN vector projects.
MIT License
1 stars 0 forks source link

Fill README #2

Open amakunin opened 5 years ago

amakunin commented 5 years ago

Here's how I see the scope of repo readme:

Any other ideas @alimanfoo @hardingnj ?

alimanfoo commented 5 years ago

Sounds good.

Yes some description of how to use as a git submodule would probably be useful.

Maybe some description of the top level folder structure would be useful, e.g., scripts - command line scripts; pipelines - snakemake/vr-pipe/CWL/... pipeline definitions; lib - importable code modules.

Open question is how we should document the actual tools. E.g., what documentation should we expect for each script under the scripts/ folder? What did you have in mind re "links to tool descriptions"?