From d5b38ca053d7b6dcd3661c7d2b6192cfc40f57b1 Mon Sep 17 00:00:00 2001 From: Clint Valentine <valentine.clint@gmail.com> Date: Mon, 20 May 2024 17:14:38 -0700 Subject: [PATCH] Add conda install instructions to README (#988) --- .gitignore | 2 ++ README.md | 19 ++++++++++++++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 2c4ce5291..554b5c03c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ .DS_Store target project/project +.metals/ +.vscode/ diff --git a/README.md b/README.md index d95b5fd62..896fcf285 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,13 @@ fgbio ==== -A set of tools to analyze genomic data with a focus on Next Generation Sequencing. This readme document is mostly for developers/contributors and those attempting to build the project from source. +A set of tools to analyze genomic data with a focus on Next Generation Sequencing. + +This readme document is mostly for developers/contributors and those attempting to build the project from source. Detailed user documentation is available on the [project website](http://fulcrumgenomics.github.io/fgbio/) including [tool usage](http://fulcrumgenomics.github.io/fgbio/tools/latest) and [documentation of metrics produced](http://fulcrumgenomics.github.io/fgbio/metrics/latest). Detailed developer documentation can be found [here](http://javadoc.io/doc/com.fulcrumgenomics/fgbio_2.13). <!---toc start--> + * [Quick Installation](#quick-installation) * [Goals](#goals) * [Overview](#overview) * [List of tools](#list-of-tools) @@ -27,6 +30,20 @@ Detailed user documentation is available on the [project website](http://fulcrum <!---toc end--> +# Quick Installation + +The [conda](https://conda.io/) package manager (configured with [bioconda channels](https://bioconda.github.io/)) can be used to quickly install fgbio: + +``` +conda install fgbio +``` + +To install fgbio without extra dependencies (e.g. [R](https://www.r-project.org/)), use the command: + +``` +conda install fgbio-minimal +``` + # Goals There are many toolkits available for analyzing genomic data; fgbio does not aim to be all things to all people but is specifically focused on providing: