From d4f33f08c441c280e28cc1e327c0f9c22cfcf3c7 Mon Sep 17 00:00:00 2001 From: Jover Lee Date: Fri, 19 Jan 2024 14:06:38 -0800 Subject: [PATCH] Add Quickstart section to the top level README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ee1a6e6..9262fad 100644 --- a/README.md +++ b/README.md @@ -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)