From fb3ed9e704c5ecd06da70a0c1ce0f0fc458de466 Mon Sep 17 00:00:00 2001
From: Calvin <calvin@EESI>
Date: Tue, 12 Mar 2013 18:05:50 -0400
Subject: initial commit of some documentation

---
 doc/index.markdown | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 doc/index.markdown

(limited to 'doc/index.markdown')

diff --git a/doc/index.markdown b/doc/index.markdown
new file mode 100644
index 0000000..5b3c430
--- /dev/null
+++ b/doc/index.markdown
@@ -0,0 +1,30 @@
+# Quikr #
+This is the homepage for quikr.
+
+
+## What is Quikr ##
+Quikr is a QUadratic, Iterative, K-mer based Reconstruction technique that
+utilizes sparsity promoting ideas from the field of compressed sensing to
+reconstruct the composition of a bacterial community (when the input data is
+454-like pyrosequencing data). This extremely fast method comes with a default
+training database but can be custom trained. Typically reconstruction is
+accurate down to the genus level.
+
+
+## How Do I Install Quikr ##
+Please read the directions on the [installation page](install.html).
+
+## How Do I use Quikr ## 
+We have several ways to use quikr. There is a python module, command line
+scripts, and matlab scripts.
+
++ [Matlab documentation](matlab.html)
++ [Python documentation](python.html)
++ [Command Line Utilities](cli.html)
+
+## Contributors ##
++ David Koslicki
++ Gail Rosen
++ Calvin Morrison
++ Jean-Luc Bouchot
+
-- 
cgit v1.2.3