From 33821bf1e64a562efa4507c7b3a7d88344db2f07 Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Fri, 18 Nov 2011 12:26:43 -0800 Subject: [PATCH] README clarifications. --- README => README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) rename README => README.md (78%) diff --git a/README b/README.md similarity index 78% rename from README rename to README.md index ad14efe..75a28d3 100644 --- a/README +++ b/README.md @@ -14,19 +14,27 @@ The following programs are provided. See the individual man pages for more information. -*fastq-grep* : match sequences against regular expressions +* *fastq-grep* : match sequences against regular expressions -*fastq-kmers* : count k-mer occurrences +* *fastq-kmers* : count k-mer occurrences -*fastq-match* : (smith-waterman) local sequence alignment +* *fastq-match* : (smith-waterman) local sequence alignment + +* *fastq-qual* : tabulate quality scores + +* *fastq-sample* : randomly sample reads, with or without replacement + +* *fastq-uniq* : count duplicate reads -*fastq-uniq* : count duplicate reads install ------- -On most systems, this is a simple `./configure && make install`. +On most systems, installation is as simple as `./configure && make install`. + +If the source was obtained from the git repository, the included `./autogen.sh` +script must be run first to generate the `configure` script. The only external dependencies are PCRE (http://www.pcre.org/) and zlib (http://zlib.net/). -- 2.39.2