diff options
| -rw-r--r-- | README.markdown | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown index fa7f44f..425b05d 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,7 @@ # Quikr # This is the homepage for quikr. -## What is 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 @@ -10,10 +10,11 @@ databases that can be custom trained. Typically reconstruction is accurate down to the genus level. -## How Do I Install Quikr ## +## How Do I Install Quikr? ## Please read the directions on the [installation page](doc/install.markdown). -## How Do I use Quikr ## + +## 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. @@ -21,13 +22,16 @@ line utility, but we also provide python and matlab scripts. + [Matlab documentation](doc/matlab.markdown) + [Python documentation](doc/python.markdown) + ## Contact ## For issues with the quikr software, contact gailro@gmail.com + ## License ## The Quikr project is released under the GPL-3 License. Please view the [LICENSE](LICENSE) file for more details. + ## Contributors ## + David Koslicki + Simon Foucart |