aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index aa2f232..c217e1c 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
-dna-utils
-=========
+# dna-utils
-general utilities for manipulating sequences and fasta files - high performance kmer counting
+This repository contains general utilities for processing sequences in fasta files.
-Tools included
-==============
-kmer_total_count - this program will count each kmer, and print to standard out.
+### Tools included ###
-arguemnts: fasta_file kmer_size
-example: kmer_total_count SuperManSequences.fasta 8
+kmer_total_count - this program will count each kmer in a fasta file, and print to standard out.
+
+#### Usage
+
+ kmer_total_count filename kmer_size
+
+ # Example
+ calvin@barnabas:~/dna-utils$ ./kmer_total_count SuperManSequences.fasta 8
the order of the array corresponds to AAAA, AAAC, AAAG, AAAT and so on