From f38327c25d197c04da485d8691a463f10bc10fd4 Mon Sep 17 00:00:00 2001
From: Blaise Li <blaise.li__git@nsup.org>
Date: Mon, 24 Feb 2020 18:04:46 +0100
Subject: [PATCH] Added README file.

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d39ae40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Miscellaneous utilities for snakemake workflows.
+
+This package contains utilities I use in my snakemake workflows.
+
+
+## Installing
+
+Get the source using `git clone git@gitlab.pasteur.fr:bli/libworkflows.git`,
+`cd` into it and run `python3 -m pip install .`
+
+It might also work directly:
+
+    python3 -m pip install git+ssh://git@gitlab.pasteur.fr/bli/libworkflows.git
+
+
+## Citing
+
+If you use this package, please cite the following paper:
+
+> Barucci et al, 2020 (doi: [10.1038/s41556-020-0462-7](https://doi.org/10.1038/s41556-020-0462-7))
+
-- 
GitLab