aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..049f502
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# boltzbub
+
+…Lattice Boltzmann code experiment written in C++ that is to a full LBM code as a boy is to a man.
+
+![lid driven cavity with a grid of boxes visualized using ParaView](screenshot/lid_driven_cavity_with_box_grid.png)
+
+## Build
+
+ git clone https://github.com/KnairdA/boltzbub.git
+ cd boltzbub
+ nix-shell
+ mkdir --parents build/result
+ cd build
+ cmake ..
+ make