From 906f916e1c9a90f14f53530499e7c98163c078a1 Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Thu, 2 Aug 2018 21:31:46 +0200
Subject: Add README and screenshot

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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
-- 
cgit v1.2.3