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 /doc/README.markdown | |
| parent | 70635868811279759c823b3e1198c1c261e0108e (diff) | |
move the readme
Diffstat (limited to 'doc/README.markdown')
| -rw-r--r-- | doc/README.markdown | 32 |
1 files changed, 0 insertions, 32 deletions
diff --git a/doc/README.markdown b/doc/README.markdown deleted file mode 100644 index d23799e..0000000 --- a/doc/README.markdown +++ /dev/null @@ -1,32 +0,0 @@ -# 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.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 |