Skip to content

Commit

Permalink
Add Quickstart section to the top level README
Browse files Browse the repository at this point in the history
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
  • Loading branch information
joverlee521 committed Jan 19, 2024
1 parent 5f11069 commit d4f33f0
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
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 .
```

## Documentation

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

0 comments on commit d4f33f0

Please sign in to comment.