From 9acbe90343e190fbc3d482857e2d72330ffe693e Mon Sep 17 00:00:00 2001
From: philippun <philippungrund@icloud.com>
Date: Mon, 14 Aug 2023 11:51:55 +0200
Subject: [PATCH] updated README.md in src

---
 src/README.md | 54 ++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 40 insertions(+), 14 deletions(-)

diff --git a/src/README.md b/src/README.md
index 420608f..8879bf5 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,18 +1,44 @@
-<h1>src Directory</h1>
+<h1>src-Directory</h1>
 
 <pre>
 src/  
-    ├── CMakeFiles/
-    ├── Boundary.cpp  
-    ├── BoundaryCondition.cpp 
-    ├── BTCS.cpp  
-    ├── BTCSv2.cpp
-    ├── CMakeLists.txt  
-    ├── FTCS.cp
-    ├── Grid.cpp 
-    ├── README.md
-    ├── Simulation.cpp
-    ├── Solver.cpp  
-    └── TugUtils.hpp 
+  ├── CMakeFiles/
+  ├── Boundary.cpp  
+  ├── BoundaryCondition.cpp 
+  ├── BTCS.cpp  
+  ├── BTCSv2.cpp
+  ├── CMakeLists.txt  
+  ├── FTCS.cpp
+  ├── Grid.cpp 
+  ├── README.md
+  ├── Simulation.cpp
+  ├── Solver.cpp  
+  └── TugUtils.hpp 
+</pre>
+
+**src/** Directory with the source code.
+
+**CMakeFiles/** Automatically generated directory by CMake.
+
+**Boundary.cpp** Implementation of Boundary class, that holds the boundary conditions.
+
+**BoundaryCondition.cpp** <i>Outdated</i> implementation of boundary conditions.
+
+**BTCS.cpp** <i>Outdated</i> implementation of BTCS solution to homogeneous diffusion.
+
+**BTCSv2.cpp** Implementation of BTCS solution to heterogeneous diffusion in 1D and 2D. 
+
+**CMakeLists.txt** CMakeLists for this directory.
+
+**FTCS.cpp** Implementation of FTCS solution to heterogeneous diffusion in 1D and 2D. 
+
+**Grid.cpp** Implementation of Grid class, that holds all of the concentrations alpha coefficient in x- and y-direction.
+
+**README.md** <i>This</i> file.
+
+**Simulation.cpp** Implementation of Simulation class, that holds all of the information for a specific simulation run, as well as the Boundary and Grid objects. 
+
+**Solver.cpp** <i>Outdated</i> implementation of Eigen solvers.
+
+**TugUtils.hpp** Helper functions for other source files. 
 
-</pre>
\ No newline at end of file