Add some user friendly features

.github/workflows/chsm_crf_ci.yml

@@ -0,0 +1,42 @@
+name: chsm_crf_ci
+
+on:
+  push:
+    branches: [feature/multi_lang_sm_gen, feature/fix_test_runs, master, main ]
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+
+    - name: List out the directory
+      run: tree ${{ github.workspace }}
+
+    - name: Check cmake version
+      run: cmake --version
+
+    - name: Configure CMake
+      # Configure CMake in  a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: cmake -B ${{github.workspace}}/build -S ${{github.workspace}} -DCHSM_BUILD_TESTS=ON
+
+    - name: Build
+      # Build your program with the given configuration
+      run: cmake --build ${{github.workspace}}/build -t crf
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.  
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: |
+        cmake --build . -t crf_test
+        ctest -VV -R crf_test
+

.github/workflows/chsm_modules_ci.yml

@@ -0,0 +1,47 @@
+name: chsm_modules_ci
+
+on:
+  push:
+    branches: [ feature/multi_lang_sm_gen, feature/fix_test_runs, master, main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+
+    - name: List out the directory
+      run: tree ${{ github.workspace }}
+
+    - name: Check cmake version
+      run: cmake --version
+
+    - name: Init the submodules
+      run: git submodule init 
+
+    - name: Update submodules
+      run: git submodule update --recursive
+
+    - name: Install Graphviz
+      # You may pin to the exact commit or the version.
+      # uses: tlylt/install-graphviz@b2201200d85f06f0189cb74d9b69208504cf12cd
+      uses: tlylt/install-graphviz@v1.0.0
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -S ${{github.workspace}} -DCHSM_BUILD_TESTS=ON
+
+    - name: Build
+      # Build your program with the given configuration
+      run: cmake --build ${{github.workspace}}/build -t all
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.  
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: |
+        ctest
+

.github/workflows/docs_pages.yml

@@ -0,0 +1,43 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - feature/multi_lang_sm_gen
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install Sphinx m2r sphinxcontrib-plantuml sphinx-rtd-dark-mode sphinxcontrib-datatemplates sphinxcontrib-drawio
+
+    - name: Install Draw.io
+      run: |
+        sudo apt-get update
+        sudo apt install snapd
+        sudo snap install drawio
+
+    - name: Build documentation
+      run: |
+        cd docs/doc_gen
+        make html
+        ls -lah
+        tree
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/doc_gen/build/html

.gitignore

@@ -1,7 +1,14 @@
-/.vscode/
 /**/__pycache__/
 /**/build/*
 !/**/build/.keep
 
 #dependencies
-**/deps/**
+**/unity/**build-mingw-test/
+build-mingw-test/
+
+build-mingw/
+
+.vscode/settings.json
+
+docs/sphinx/_build/
+docs/typst/*.pdf

.gitmodules

@@ -0,0 +1,11 @@
+[submodule "languages/c/cmake_utils"]
+	path = languages/c/cmake_utils
+	url = https://github.com/xsession/cmake_utils.git
+[submodule "languages/c/unity"]
+	path = languages/c/unity
+	url = https://github.com/xsession/Unity.git
+[submodule "languages/c/examples/menu_structure"]
+	url = https://github.com/xsession/menu_structure.git
+[submodule "docs/modules"]
+	path = docs/modules
+	url = https://github.com/xsession/chsm-docs.git

.vscode/launch.json

@@ -0,0 +1,102 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "i2c_master_test_debug",
+            "type": "cppdbg",
+            "request": "launch",
+            // "preLaunchTask": "build_i2c_master_test",
+            "program": "${workspaceFolder}/languages/c/build-mingw-test/bin/i2c_master_test.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${fileDirname}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "miDebuggerPath": "C:/MinGW/bin/gdb.exe",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Set Disassembly Flavor to Intel",
+                    "text": "-gdb-set disassembly-flavor intel",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Display numbers in hex",
+                    "text": "set output-radix 16",
+                    "ignoreFailures": true
+                }
+            ]
+        },
+        {
+            "name": "lm73_test_debug",
+            "type": "cppdbg",
+            "request": "launch",
+            // "preLaunchTask": "build_lm73_test",
+            "program": "${workspaceFolder}/languages/c/build-mingw-test/bin/lm73_test.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${fileDirname}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "miDebuggerPath": "C:/MinGW/bin/gdb.exe",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Set Disassembly Flavor to Intel",
+                    "text": "-gdb-set disassembly-flavor intel",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Display numbers in hex",
+                    "text": "set output-radix 16",
+                    "ignoreFailures": true
+                }
+            ]
+        },
+        {
+            "name": "sht30_test_debug",
+            "type": "cppdbg",
+            "request": "launch",
+            // "preLaunchTask": "build_sht30_test",
+            "program": "${workspaceFolder}/languages/c/build-mingw-test/bin/sht30_test.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${fileDirname}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "miDebuggerPath": "C:/MinGW/bin/gdb.exe",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Set Disassembly Flavor to Intel",
+                    "text": "-gdb-set disassembly-flavor intel",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Display numbers in hex",
+                    "text": "set output-radix 16",
+                    "ignoreFailures": true
+                }
+            ]
+        },
+
+    ]
+}

README.md

@@ -1,3 +1,6 @@
+[![Actions Status](https://github.com/xsession/chsm/workflows/chsm_crf_ci/badge.svg)](https://github.com/xsession/chsm/actions)
+[![Actions Status](https://github.com/xsession/chsm/workflows/chsm_modules_ci/badge.svg)](https://github.com/xsession/chsm/actions)
+
 # CHSM - Hierarchical State Machine (HSM) Framework for C
 
 :warning: **Experimental code, expect breaking changes.**
@@ -49,7 +52,25 @@ Cloning: `git clone https://github.com/ThrowTheSwitch/Unity.git`
 1. Clone the repo
 2. Checkout the **master** branch
 3. Navigate into the **chsm** folder, open a command prompt and run this command:
-   **python3 cgen/chsm_backend.py**
+**python3 cgen/chsm_backend.py**
 
 The result should be a new window with a simple state machine already in it.
 
+
+## Compile modules
+
+### To run one individual test, build and run it
+```
+cd build
+cmake --build . -t lm73_test; ctest -VV -R lm73_test
+```
+### Build and run all tests with one command
+```
+cd build
+cmake --build . -t ; ctest -VV -R 
+```
+### To listout all target
+```
+cd build
+make help
+```