From fc58dab96f27624435a1c08480234a7c03071e27 Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Wed, 30 Oct 2019 19:40:56 +0100
Subject: Extract settings into config file, add documentation

---
 ldc_2d/cpp/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 ldc_2d/cpp/README.md

(limited to 'ldc_2d/cpp/README.md')

diff --git a/ldc_2d/cpp/README.md b/ldc_2d/cpp/README.md
new file mode 100644
index 0000000..8e84c83
--- /dev/null
+++ b/ldc_2d/cpp/README.md
@@ -0,0 +1,18 @@
+# Lid driven cavity
+
+This example models the common lid driven cavity example.
+Note that the actual optimized C++ implementation is generated using the _boltzgen_ library.
+
+See `config.py` for various configuration options. Both 2D and 3D are supported.
+
+## Build instructions
+
+```
+mkdir build
+cd build
+cmake ..
+make
+./ldc
+```
+
+This should result in some summarizing CLI output in addition to a `test.vtk` file for visualization in Paraview.
-- 
cgit v1.2.3