aboutsummaryrefslogtreecommitdiff
path: root/doc/matlab.markdown
diff options
context:
space:
mode:
authorCalvin Morrison <mutantturkey@gmail.com>2013-05-28 12:04:35 -0400
committerCalvin Morrison <mutantturkey@gmail.com>2013-05-28 12:04:35 -0400
commit2a25a225adcdf8bed6e27963758e7e5740a921e2 (patch)
treed35a695319ff292640d50fcc01aa44eacb27655c /doc/matlab.markdown
parentdb2c0af8987e341ece4414c5c85471f66938d5c9 (diff)
Added not about generate_kmers
Added notes to the matlab documentation about the generate kmers requirement.
Diffstat (limited to 'doc/matlab.markdown')
-rw-r--r--doc/matlab.markdown9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/matlab.markdown b/doc/matlab.markdown
index 1e990d9..ec9249c 100644
--- a/doc/matlab.markdown
+++ b/doc/matlab.markdown
@@ -1,6 +1,13 @@
# Quikr's Matlab Implementation #
The Quikr implementation works in Matlab and also works in Octave, but the
-Octave version will run much slower
+Octave version will run much slower.
+
+You will need to install the generate_kmers tool into your $PATH (eg /usr/bin/)
+this file is available in the src/python/ directory. If you use make to install
+the quikr project, it will already be installed. To test this you can run:
+
+ which generate_kmers
+
## Quikr Example ##
This is an example of how to run Quikr. Before you try the example please make