From 55629610f861d1540acbdade73d80f0f17c9cc6d Mon Sep 17 00:00:00 2001 From: Lee Katz - Aspen Date: Mon, 27 Nov 2023 11:45:34 -0500 Subject: [PATCH] cargo install command --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ad98c639..1233ec51 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 using the following command: + + cargo install fasten + +Detailed information on how this works can be found in the cargo handbook at . + ## 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`.