Create README.md

Gprisco · Apr 7, 2024 · ac6b949 · ac6b949
1 parent c9b1dd0
commit ac6b949
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# RS Sequence Alignment
+A simple rust CLI program which executes the Dynamic Programming Needleman–Wunsch algorithm for aligning 2 DNA sequences supplied through argv.
+
+* Example usage
+```sh
+cargo r CACACG CACTGCAT
+```
+* Example output
+```text
+    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
+     Running `target/debug/rs-sequence-alignment CACACG CACTGCAT`
+CAC-AC-G
+CACTGCAT
+```