aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 5 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e9503bc
--- /dev/null
+++ b/README
@@ -0,0 +1,5 @@
+This infers a phylogentic tree from SNV calls. The input file format is textual
+with rows corresponding to (copy-neutral) SNV calls that contain an identifier
+(ignored) and any number count/depth pairs separated by whitespace. Count and
+depth must be natural numbers with count ≤ depth. See `--help` flag for
+options.