Update sphinx usage docs

kdm9 · Oct 21, 2015 · 6f732df · 6f732df
1 parent 5e5bc1a
commit 6f732df
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,13 +2,20 @@
 Axe Usage
 *********
 
+.. note::
+  For arcane reasons, the name of the ``axe`` binary changed to ``axe-demux``
+  with version 0.3.0. Apologies for the inconvenience, this was required to
+  make ``axe`` installable in Debian and its derivatives. Command-line usage
+  did not change.
+
 Axe has several usage modes. The primary distinction is between the two
 alternate barcoding schemes, single and combinatorial barcoding. Single barcode
 matching is used when only the first read contains barcode sequences.
 Combinatorial barcoding is used when both reads in a read pair contain
 independent (typically different) barcode sequences.
 
-For concise reference, the command-line usage of ``axe`` is reproduced below:
+For concise reference, the command-line usage of ``axe-demux`` is reproduced
+below:
 
 .. literalinclude:: usage.txt
 

diff --git a/docs/usage.txt b/docs/usage.txt
@@ -1,7 +1,7 @@
 USAGE:
-axe [-mzc2pt] -b (-f [-r] | -i) (-F [-R] | -I)
-axe -h
-axe -v
+axe-demux [-mzc2pt] -b (-f [-r] | -i) (-F [-R] | -I)
+axe-demux -h
+axe-demux -v
 
 OPTIONS:
     -m, --mismatch	Maximum hamming distance mismatch. [int, default 1]