added a bit readme

charnley · Mar 26, 2018 · 7f6fa7f · 7f6fa7f
1 parent e8f90dc
commit 7f6fa7f
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/rmsd++/README.md b/rmsd++/README.md
@@ -0,0 +1,16 @@
+
+# C++ version, under development
+
+Will eventually have Python bindings
+
+## Compile
+
+    make calculate_rmsd
+
+## Usage
+
+only kabsch and --output is implemented
+
+    ./calculate_rmsd --output alpha.xyz omega.xyz
+
+