Skip to content

Commit

Permalink
Add conda install instructions to README (#988)
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval authored May 21, 2024
1 parent ba0788e commit d5b38ca
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
.DS_Store
target
project/project
.metals/
.vscode/
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:
Expand Down

0 comments on commit d5b38ca

Please sign in to comment.