Skip to content

Commit 569c2ba

Browse files
committed
ran the readme through the markdown linter
1 parent e41ca44 commit 569c2ba

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
[![Crates.io](https://img.shields.io/crates/v/fasten)](https://crates.io/crates/fasten)
2-
31
# Fasten
42

3+
[![Crates.io](https://img.shields.io/crates/v/fasten)](https://crates.io/crates/fasten)
4+
55
A powerful manipulation suite for interleaved fastq files.
66
Executables can read/write to `stdin` and `stdout`, and they are compatible with the interleaved fastq format.
77
This makes it much easier to perform streaming operations using unix pipes.
88

99
## Synopsis
1010

1111
### read metrics
12-
12+
1313
$ cat testdata/R1.fastq testdata/R2.fastq | \
1414
fasten_shuffle | fasten_metrics | column -t
1515
totalLength numReads avgReadLength avgQual
@@ -27,8 +27,6 @@ This makes it much easier to perform streaming operations using unix pipes.
2727
800 8 100 19.53875
2828
# No reads were actually filtered with cleaning, with --min-length=2
2929

30-
_etc_
31-
3230
## Installation
3331

3432
### Installation from source
@@ -43,18 +41,17 @@ After downloading, use the Rust executable `cargo` like so:
4341

4442
All executables will be in the directory `fasten/target/release`.
4543

46-
_note_: there are some `Makefile` methods to help including
44+
_note_: there are some `Makefile` methods to help including
4745

4846
* `make all` to make the following
4947
* `make release` install fast executables
5048
* `make debug` install executables quickly (although the executables will not be optimized)
5149
* `make fasten/doc` compile lastest documents
5250
* `make clean` uninstall local binaries
5351

54-
5552
### Installation without `git`
5653

57-
You can also install Fasten straight from <https://crates.io> using the following command:
54+
You can also install Fasten straight from <https://crates.io> using the following command:
5855

5956
cargo install fasten
6057

@@ -71,7 +68,7 @@ All scripts accept the parameters, read uncompressed fastq format from stdin, an
7168

7269
## Documentation
7370

74-
Please see the inline documentation at https://lskatz.github.io/fasten/fasten
71+
Please see the inline documentation at <https://lskatz.github.io/fasten/fasten>
7572

7673
This documentation was built with `cargo docs --no-deps`
7774

@@ -121,4 +118,3 @@ that indicates that you are securing your analysis by "fasten"ing it (with a sil
121118
## Acknowledgements
122119

123120
Thank you Henk Den Bakker for many helpful discussions around Rust, helping me name this software, and many other things.
124-

0 commit comments

Comments
 (0)