summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08b9038
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Build everything
+cargo build --all
+
+# Build just the library
+cargo build -p meta_affine
+
+# Build just the CLI
+cargo build -p morphology-cli
+
+# Run tests
+cargo test --all
+
+# Run the generate command
+cargo run --bin generate 5
+
+# Install the CLI tool globally
+cargo install --path morphology-cli