From 2b694375b2b6313eda5c61773cb5b96f2ff39ca3 Mon Sep 17 00:00:00 2001
From: Peter van 't Hof <p.j.van_t_hof@lumc.nl>
Date: Mon, 17 Aug 2015 06:47:57 +0200
Subject: [PATCH] Added requirements to docs
---
docs/general/requirements.md | 17 +++++++++++++++++
mkdocs.yml | 1 +
2 files changed, 18 insertions(+)
create mode 100644 docs/general/requirements.md
diff --git a/docs/general/requirements.md b/docs/general/requirements.md
new file mode 100644
index 000000000..b2664e9b6
--- /dev/null
+++ b/docs/general/requirements.md
@@ -0,0 +1,17 @@
+### System Requirements
+
+Biopet is build on top of GATK Queue, which requires having `java` installed on the analysis machine(s).
+
+For end-users:
+
+ * [Java 7 JVM](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or [OpenJDK 7](http://openjdk.java.net/install/)
+ * [Cran R 2.15.3](http://cran.r-project.org/)
+
+For developers:
+
+ * [OpenJDK 7](http://openjdk.java.net/install/)
+ * Minimum of 4 GB RAM {todo: provide more accurate estimation on building}
+ * Maven 3
+ * Compiled and installed in maven repository version of [GATK + Queue](https://github.com/broadgsa/gatk-protected/)
+ * IntelliJ or Netbeans 8.0 for development
+
diff --git a/mkdocs.yml b/mkdocs.yml
index b5cb8fdb5..87a79146a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -3,6 +3,7 @@ pages:
- Home: 'index.md'
- General:
- Config: 'general/config.md'
+ - Requirements: 'general/requirements.md'
- Pipelines:
- Basty: 'pipelines/basty.md'
- Bam2Wig: 'pipelines/bam2wig.md'
--
GitLab