Skip to content

Commit

Permalink
cargo install command
Browse files Browse the repository at this point in the history
  • Loading branch information
lskatz committed Nov 27, 2023
1 parent faa167f commit 5562961
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ _etc_

## Installation

### Installation from source

Fasten is programmed in the Rust programming language. More information about Rust, including installation and the executable `cargo`, can be found at [rust-lang.org](https://www.rust-lang.org).

After downloading, use the Rust executable `cargo` like so:
Expand All @@ -39,6 +41,14 @@ After downloading, use the Rust executable `cargo` like so:

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

### Installation without `git`

You can also install Fasten straight from <https://crates.io> using the following command:

cargo install fasten

Detailed information on how this works can be found in the cargo handbook at <https://doc.rust-lang.org/cargo/commands/cargo-install.html>.

## General usage

All scripts accept the parameters, read uncompressed fastq format from stdin, and print uncompressed fastq format to stdout. All paired end fastq files must be in interleaved format, and they are written in [interleaved format](./docs/file-formats.md), except when deshuffling with `fasten_shuffle`.
Expand Down

0 comments on commit 5562961

Please sign in to comment.