From 64401bfa86ff26266a329901d98910a87b7a9560 Mon Sep 17 00:00:00 2001
From: Benedikt Moritz Maurer <benedikt.moritz.maurer@physik.hu-berlin.de>
Date: Sat, 5 Oct 2024 15:13:39 +0200
Subject: [PATCH] add README.md

---
 .github/workflows/ci.yml                      |  2 +-
 README.md                                     | 54 +++++++++++++++++++
 .../include/data_processing/read_hdf5.h       |  2 +-
 3 files changed, 56 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 77d49f7..69dc72d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -19,7 +19,7 @@ jobs:
 
     - name: Install dependencies
       run: sudo apt-get update && sudo apt-get install -y 
-        g++ cmake libyaml-cpp-dev catch2 libeigen3-dev doxygen libhdf5-dev
+        g++ cmake libyaml-cpp-dev catch2 libeigen3-dev doxygen libhdf5-dev boost
 
     - name: Create build directory
       run: mkdir build
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5598793
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+This is flash, a super fast BSE solver.
+
+# Install:
+To build **Flash** with debug flags, release flags and the documentation type in the root directory
+```bash
+make 
+```
+You can seperately build **Flash** with debug flags, release flags or the documentation seperately by typing, respectively
+```bash
+make debug
+make release
+make documentation
+```
+If you wish to make build the documentation, make sure that doxygen is installed.
+
+## Run unit tests:
+Run all tests:
+```
+make test
+```
+Run debug or release build tests
+```bash
+make test-debug
+make test-release
+```
+
+## Lint and auto-format the code:
+To run first **clang-tidy** and then **clang-format** for all files, type
+```bash
+make linter
+
+```
+To run **clang-tidy** or then**clang-format**, type, respectively
+```bash
+make clang-tidy
+make clang-format
+```
+
+## Requirements:  
+  For building:
+    - CMake > 
+    - Eigen
+    - HDF5
+    - cpp-yaml
+    - catch2
+    - boost
+  For the documentation
+    - doxygen
+  For linting and auto formatting:
+    - clang-tidy
+    - clang-format
+  
+
+    
\ No newline at end of file
diff --git a/dev/libs/data_processing/include/data_processing/read_hdf5.h b/dev/libs/data_processing/include/data_processing/read_hdf5.h
index 059ce9a..2fbe717 100644
--- a/dev/libs/data_processing/include/data_processing/read_hdf5.h
+++ b/dev/libs/data_processing/include/data_processing/read_hdf5.h
@@ -26,4 +26,4 @@ flash::types::DVector readDoubleVectorHDF5(const std::string &filename, const st
 }  // namespace data_processing
 }  // namespace flash
 
-#endif  // FLASH_READ_H
\ No newline at end of file
+#endif  // FLASH_READ_H 
\ No newline at end of file