Skip to content

Commit 53f45b4

Browse files
committed
update readme
1 parent 70a079a commit 53f45b4

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,23 @@ Just give the sequences, sabreur know how to handle it!
4848

4949
```
5050
USAGE:
51-
sabreur [FLAGS] [OPTIONS] <BARCODE> <FORWARD> [REVERSE]
51+
sabreur [options] <BARCODE> <FORWARD FILE> [<REVERSE FILE>]
5252
53-
FLAGS:
54-
--force Force reuse of output directory
55-
-h, --help Prints help information
56-
-q, --quiet Decrease program verbosity
57-
-V, --version Prints version information
53+
ARGS:
54+
<BARCODE> input barcode file
55+
<FORWARD> input forward fastx file
56+
<REVERSE> input reverse fastx file
5857
5958
OPTIONS:
60-
-f, --format <format> Set output files compression format. [possible values: gz, xz, bz2]
61-
-l, --level <level> Set the compression level [default: 1] [possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9]
62-
-m, --mismatch <N> Maximum number of mismatches allowed in a barcode [default: 0]
63-
-o, --out <FOLDER> Output folder [default: sabreur_out]
59+
-m, --mismatch <INT> maximum number of mismatches [default: 0]
60+
-o, --out <DIR> ouput directory [default: sabreur_out]
61+
-f, --format <STR> output files compression format
62+
-l, --level <INT> compression level [default: 1]
63+
--force force reuse of output directory
64+
-q, --quiet decrease program verbosity
65+
-h, --help Print help information
66+
-V, --version Print version information
6467
65-
ARGS:
66-
<BARCODE> Input barcode file.
67-
<FORWARD> Input forward fasta or fastq file. Can be gz, xz or bz2 compressed.
68-
<REVERSE> Input reverse fasta or fastq file. Can be gz, xz or bz2 compressed.
6968
```
7069

7170
## Requirements

0 commit comments

Comments
 (0)