Add Quickstart section to the top level README #30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Requested internally by @trvrb to point to add a Quickstart section to point people to the primary workflow of the repo.¹ ¹ https://bedfordlab.slack.com/archives/C0KQCN813/p1705696505953639
joverlee521
added a commit
to nextstrain/mpox
that referenced
this pull request
Jan 19, 2024
Mirroring changes made in nextstrain/zika#30.
1 task
tsibley
reviewed
Jan 19, 2024
Comment on lines
+16
to
+18
| cd phylogenetic/ | ||
| nextstrain build . | ||
| nextstrain view . |
There was a problem hiding this comment.
This could be two lines as well:
Suggested change
| cd phylogenetic/ | |
| nextstrain build . | |
| nextstrain view . | |
| nextstrain build phylogenetic/ | |
| nextstrain view phylogenetic/ |
There was a problem hiding this comment.
Cool! I think I might prefer the 3-line cd version as https://github.com/nextstrain/zika/blob/main/phylogenetic/README.md seems to be suggesting to run from within phylogenetics/ directory. (However, realize now that this actually needs to be spelled out in that readme). Basically expecting Quickstart to not deviate too heavily from the longer version of Usage.
There was a problem hiding this comment.
I just added a note on this here https://github.com/nextstrain/zika/pull/30/files#diff-0442ef409a305d27ae6b86f4cd48a1cf192e966cc8cf2e2da016fd63375408fbR17
1. Installation section in top-level readme (I'm always looking for this) 2. Make it clearer that phylogenetic workflow needs to be run from within the phylogenetic/ directory
trvrb
approved these changes
Jan 19, 2024
j23414
approved these changes
Jan 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Requested internally by @trvrb to point to add a Quickstart section to point people to the primary workflow of the repo.¹
¹ https://bedfordlab.slack.com/archives/C0KQCN813/p1705696505953639
Checklist