aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Bedo <cu@cua0.org>2018-11-27 12:50:46 +1100
committerJustin Bedo <cu@cua0.org>2018-11-27 12:51:19 +1100
commitfce03fcbdbea445bc058348db30ccb99274d3f96 (patch)
tree7ce6e6a0f674e0655fe210b85596670e01d76a43 /README.md
parent342df165afb5961557d61bb4cb9a39b88b22d220 (diff)
Expand README and add simple example pipeline
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index d71b0e5..92817c2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
# bionix
-Nix functions for use in bioinformatics, and a sample DE analysis
+
+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).