From 8418445855a8119da6634807a15fdb2df1a5ec17 Mon Sep 17 00:00:00 2001 From: Lauren Coombe Date: Tue, 3 Dec 2024 14:17:04 -0800 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c77303e..5bcd921 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,13 @@ conda install --yes -c conda-forge -c bioconda quicktree snakemake intervaltree R -e 'install.packages(c("gggenomes"), repos = "https://cran.r-project.org")' ``` +### Setting up environment to run ntSynt-viz +Once all dependencies are installed, simply clone the source code, and add the `bin` directory to your PATH +``` +git clone https://github.com/bcgsc/ntSynt-viz.git +export PATH=/path/to/ntsynt-viz/github/ntSynt-viz/bin:$PATH +``` + ## Usage ``` usage: ntsynt_viz.py [-h] --blocks BLOCKS --fais FAIS [FAIS ...] [--name_conversion NAME_CONVERSION] [--tree TREE] [--target-genome TARGET_GENOME] [--normalize]