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

Improve usage documentation #14

Open
tmaklin opened this issue Jul 21, 2021 · 0 comments
Open

Improve usage documentation #14

tmaklin opened this issue Jul 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tmaklin
Copy link
Collaborator

tmaklin commented Jul 21, 2021

Several points should be addressed in the documentation in order to make mGEMS easier to adopt.

  • Add more information about how to use (and install) themisto & mSWEEP since they are essential parts of the pipeline.
  • Create a new tutorial on how to prepare a reference database and use pubMLST or PopPUNK to assign the reference sequences to lineages.
@tmaklin tmaklin added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tmaklin