doc templates

Atemia · Oct 31, 2018 · f2ea458 · f2ea458
1 parent 341f471
commit f2ea458
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,23 @@
 ENCODE RNA-seq pipeline
 =================================================
 [![Docker Repository on Quay](https://quay.io/repository/encode-dcc/rna-seq-pipeline/status "Docker Repository on Quay")](https://quay.io/repository/encode-dcc/rna-seq-pipeline)
+
+OVERVIEW
+------------
+This is the ENCODE-DCC RNA-sequencing pipeline. The scope of the pipeline is to align reads, generate signal tracks, and quantify genes and isoforms.
+
+INSTALLATION
+-------------
+Installation instructions [here](docs/installation.md)
+
+HOWTO
+------
+Howto guides [here](docs/howto.md)
+
+TUTORIALS
+-----------
+Tutorials [here](docs/tutorials.md)
+
+REFERENCE
+----------
+Reference [here](docs/reference.md) 
diff --git a/docs/howto.md b/docs/howto.md
@@ -0,0 +1,2 @@
+HOWTO
+========
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,2 @@
+INSTALLATION
+=============
diff --git a/docs/reference.md b/docs/reference.md
@@ -0,0 +1,2 @@
+REFERENCE
+===========
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,2 @@
+TUTORIALS
+===========