在README中添加Usage
This commit is contained in:
parent
52c5610f1c
commit
f3dc2c30f8
19
README.md
19
README.md
|
|
@ -32,10 +32,11 @@ Use spdlog as log tool and the default level is 'info'.
|
|||
|
||||
### Build tools
|
||||
|
||||
* autoconf (for htslib)
|
||||
* cmake
|
||||
* c++17 (gcc >= 8.1 or clang >= 7 should work.)
|
||||
|
||||
### Libraries need
|
||||
### Libraries needed
|
||||
|
||||
* zlib
|
||||
* libbz2
|
||||
|
|
@ -47,7 +48,7 @@ Use spdlog as log tool and the default level is 'info'.
|
|||
|
||||
Download a distribution tarball `FastDup.tar.gz` or clone the source codes from github.
|
||||
|
||||
```
|
||||
```bash
|
||||
# build htslib
|
||||
cd FastDup/ext/htslib
|
||||
autoreconf -i
|
||||
|
|
@ -60,3 +61,17 @@ mkdir build && cd build
|
|||
cmake .. -DCMAKE_BUILD_TYPE=Release
|
||||
make && sudo make install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
1. get help
|
||||
|
||||
```bash
|
||||
fastdup --help
|
||||
```
|
||||
|
||||
2. mark duplicates on an input BAM file
|
||||
|
||||
```bash
|
||||
fastdup --input in.bam --output out.bam --metrics stats.txt --num-threads 8
|
||||
```
|
||||
Loading…
Reference in New Issue