Skip to content

Commit d5b38ca

Browse files
authored
Add conda install instructions to README (#988)
1 parent ba0788e commit d5b38ca

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
.DS_Store
66
target
77
project/project
8+
.metals/
9+
.vscode/

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@
1010
fgbio
1111
====
1212

13-
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.
13+
A set of tools to analyze genomic data with a focus on Next Generation Sequencing.
14+
15+
This readme document is mostly for developers/contributors and those attempting to build the project from source.
1416
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).
1517

1618
<!---toc start-->
19+
* [Quick Installation](#quick-installation)
1720
* [Goals](#goals)
1821
* [Overview](#overview)
1922
* [List of tools](#list-of-tools)
@@ -27,6 +30,20 @@ Detailed user documentation is available on the [project website](http://fulcrum
2730

2831
<!---toc end-->
2932

33+
# Quick Installation
34+
35+
The [conda](https://conda.io/) package manager (configured with [bioconda channels](https://bioconda.github.io/)) can be used to quickly install fgbio:
36+
37+
```
38+
conda install fgbio
39+
```
40+
41+
To install fgbio without extra dependencies (e.g. [R](https://www.r-project.org/)), use the command:
42+
43+
```
44+
conda install fgbio-minimal
45+
```
46+
3047
# Goals
3148

3249
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:

0 commit comments

Comments
 (0)