Add a README

2023-03-20 15:15:50 +00:00 · 2023-03-20 15:15:50 +00:00 · 192017d14e
commit 192017d14e
parent 10644adb54
1 changed files with 8 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,8 @@
+# DLA Generic Model
+
+A generic pluggable model for diffusion limited aggregation. Produces two executables,
+
+- `./target/release/model`, built from `./src/main.rs`
+- `./target/release/tools`, built from `./src/tools_cli.rs`
+
+Build with `cargo build --release`. Requires a working rust installation.