diff options
| author | Calvin <calvin@EESI> | 2013-05-15 13:12:22 -0400 |
|---|---|---|
| committer | Calvin <calvin@EESI> | 2013-05-15 13:12:22 -0400 |
| commit | 917871931a9adb2d707e11c2fafd4bd64591f21a (patch) | |
| tree | 16cf93d382f27291f8337dcbeae2d3fd42874244 /README.markdown | |
| parent | 70635868811279759c823b3e1198c1c261e0108e (diff) | |
move the readme
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown index 951892f..d23799e 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,32 @@ # Quikr # +This is the homepage for quikr. -To install, type "make" in top directory with Makefile. +## 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. -See more help and documentation in the doc directory. -http://sourceforge.net/p/quikr/wiki/Home/ +## How Do I Install Quikr ## +Please read the directions on the [installation page](install.markdown). + +## How Do I use Quikr ## +We have several ways to use quikr. Quikr is first and formost a command +line utility, but we also provide python and matlab scripts. + ++ [Command Line Utilities](cli.markdown) ++ [Matlab documentation](matlab.markdown) ++ [Python documentation](python.markdown) + +## Contact ## +For issues with the quikr software, contact gailro@gmail.com + +## Contributors ## ++ David Koslicki ++ Simon Foucart ++ Gail Rosen ++ Calvin Morrison ++ Jean-Luc Bouchot |