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

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

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