Home aktualisiert

Home.md

@@ -1,14 +1,32 @@
 Willkommen im Wiki.
 
-Quick info 
+# Quick info  
+   on the very beginning of developing the _control-algrorithm_
 
-1. Checkout from repo:
-     On your local machine create a fresh folder and cd into it
-     e.g. mkdir fresh & cd fresh
-3. localbuild.sh builds everything on a local machine .... after
+## 1. Checkout from repo:
+     On your local machine create a fresh folder and execute following commands
+     mkdir fresh && cd fresh
+     git clone https://gitlab.2030net.de/G_Admin/BinderBeispielRegler.git
      
--     setup of Qt6's installation path:
+## 2. localbuild.sh builds everything on a local machine .... after
+
+-     Setup of Qt6's installation path:
        Open localbuild.sh and adapt yout local Qt6 version ( path )  in line 7:
        cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DQt6_DIR=$HOME/Qt/6.10.2/gcc_64/lib/cmake/Qt6 
        
-2. type ./localbat.sh on your linux console/terminal
+## 3. Build application an controller library, type on your linux console/terminal:
+    cd BinderBeispielRegler  
+    ./localbuild.sh 
+    
+## 4. Run the application
+    build/app/app
+    - a live message is showing up
+
+## 5. Stop the application
+    - hit any key on the keyboard
+
+## 6. Test
+    Just type
+    tests/tests
+    - some dummy tests are executed, results are showing up
+