From efd9d638b2bec1ed47f2f1ddc782c17caf3fe2f8 Mon Sep 17 00:00:00 2001
From: Martin Bauer <martin.bauer@fau.de>
Date: Sun, 28 Apr 2019 15:53:04 +0200
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8204742
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+lbmpy-walberla
+==============
+[![pipeline status](https://i10git.cs.fau.de/pycodegen/lbmpy_walberla/badges/master/pipeline.svg)](https://i10git.cs.fau.de/pycodegen/lbmpy_walberla/commits/master)
+
+Formulate lattice Boltzmann methods in lbmpy and generate optimized C++ Code for waLBerla from it.
+Look at the waLBerla documentation on how to use it.
+
+Install with
+```bash
+pip install lbmpy-walberla
+```
+and enable WALBERLA_BUILD_WITH_CODEGEN in waLBerla's CMake.
-- 
GitLab