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

Add Quickstart section to the top level README #30

Merged
merged 2 commits into from
Jan 20, 2024
Merged

Add Quickstart section to the top level README #30

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4f33f0
Add Quickstart section to the top level README
joverlee521 Jan 19, 2024
85dd505
Further updates to READMEs
trvrb Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ This repository contains two workflows for the analysis of Zika virus data:

Each folder contains a README.md with more information.

## Quickstart

Follow the [standard installation instructions](https://docs.nextstrain.org/page/install.html) for Nextstrain's suite of software tools.

Then run the default phylogenetic workflow via:
```
cd phylogenetic/
nextstrain build .
nextstrain view .
Comment on lines +18 to +20
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be two lines as well:

Suggested change
cd phylogenetic/
nextstrain build .
nextstrain view .
nextstrain build phylogenetic/
nextstrain view phylogenetic/

Copy link
Member

@trvrb trvrb Jan 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added a note on this here https://github.com/nextstrain/zika/pull/30/files#diff-0442ef409a305d27ae6b86f4cd48a1cf192e966cc8cf2e2da016fd63375408fbR17

```

## Documentation

- [Contributor documentation](./CONTRIBUTING.md)