aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 92817c204dd063c40c323b00a3809c97eef5073b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# bionix

Bionix is a set of [Nix](http://nixos.org/nix) expressions for specifying and
executing bioinformatics pipelines. It is currently a work in progress, so
documentation is sparse.

## Getting started

Install [Nix](http://nixos.org/nix) and then try `nix-build` in the examples
directory.

## Example pipeline

The examples directory shows a simple pipeline in the call.nix and default.nix
files. You can build it with `nix-build` in the examples directory. The result
will be linked to ./result, which in this example case is an empty VCF file.

## Contact

Please come chat with us at [#bionix:cua0.org](http://matrix.to/#/#bionix:cua0.org).