Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

create a USAGE section on the README #11

Open
kapsakcj opened this issue Feb 19, 2019 · 0 comments
Open

create a USAGE section on the README #11

kapsakcj opened this issue Feb 19, 2019 · 0 comments

Comments

@kapsakcj
Copy link
Contributor

Would be nice to have a USAGE section on the README.md so that if others want to use the pipelines, they have the instructions to do so.

Could include:

  • Requirements / dependencies
    • local installs of tools for non-dockerized scripts
    • dockerized pipelines docker, pigz
  • Details of each pipeline (what program is run?, what results should I expect to see?)
    • type_pipe
    • pipeline_non_ref_tree_build
    • lyveset
    • nanopore scripts (not really a full-fledged pipeline yet)
  • Usage examples - run X script in this directory, receive Y files out, example commands to run the scripts
  • Known issues and/or a to-do list
  • Links to bioinformatics training videos?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kapsakcj