[restat] Added initial code base, docs

.github/workflows/restat_base_c_checker.yml

@@ -0,0 +1,33 @@
+name: restat_base C checker
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'sw/restat_base/src/**/*.c'
+      - 'sw/restat_base/src/**/*.h'
+  pull_request:
+    branches: [ master ]
+    paths:
+      - 'sw/restat_base/src/**/*.c'
+      - 'sw/restat_base/src/**/*.h'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check length of line in modules
+        id: long_line_checker
+        run: |
+          echo "Checking the length of lines in modules"
+          modules_ok=0
+          modules=($(find sw/restat_base/src/ -type f -name '*.c' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_length=$(wc -L < "${mod}"); echo "${mod} : $line_length"; [[ $line_length -gt 300 ]] && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo "All modules are good" || exit 1
+      - name: Check number of lines in modules
+        id: num_line_checker
+        run: |
+          echo "Checking the number of lines in modules"
+          modules_ok=0
+          modules=($(find sw/restat_base/src/ -type f -name '*.c' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_numbers=$(wc -l < "${mod}"); echo "${mod} : $line_numbers"; [[ $line_numbers -gt 300 ]] && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo "All modules are good" && exit 0 || exit 1

.github/workflows/restat_desktop_cc_checker.yml

@@ -1,13 +1,15 @@
-name: restat-desktop CC checker
+name: restatdesk CC checker
 on:
   push:
     branches: [ master ]
     paths:
-      - 'sw/restat-desktop/**'
+      - 'sw/restatdesk/**/*.cc'
+      - 'sw/restatdesk/**/*.h'
   pull_request:
     branches: [ master ]
     paths:
-      - 'sw/restat-desktop/**'
+      - 'sw/restatdesk/**/*.cc'
+      - 'sw/restatdesk/**/*.h'
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -16,19 +18,16 @@ jobs:
       - name: Check length of line in modules
         id: long_line_checker
         run: |
-          echo Checking length of line in modules
+          echo "Checking the length of lines in modules"
           modules_ok=0
-          modules=($(find sw/ -type f -name '*.cc' -exec echo '{}' \;))
-          for mod in "${modules[@]}"; do line_length=$(wc -L < "${mod}"); [[ $line_length -gt 80 ]] && modules_ok=1; done
-          [[ $modules_ok -eq 0 ]] && echo ::set-output name=status::success || echo ::set-output name=status::failure
+          modules=($(find sw/restatdesk/ -type f -name '*.cc' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_length=$(wc -L < "${mod}"); echo "${mod} : $line_length"; [[ $line_length -gt 500 ]] && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo "All modules are good" || exit 1
       - name: Check number of lines in modules
         id: num_line_checker
         run: |
-          echo Checking number of lines in modules
+          echo "Checking the number of lines in modules"
           modules_ok=0
-          modules=($(find sw/ -type f -name '*.cc' -exec echo '{}' \;))
-          for mod in "${modules[@]}"; do line_numbers=$(wc -l < "${mod}"); [[ $line_numbers -gt 300 ]] && modules_ok=1; done
-          [[ $modules_ok -eq 0 ]] && echo ::set-output name=status::success || echo ::set-output name=status::failure
-      - name: Check on failures
-        if: steps.long_line_checker.outputs.status == 'failure' || steps.num_line_checker.outputs.status == 'failure'
-        run: exit 1
+          modules=($(find sw/restatdesk/ -type f -name '*.cc' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_numbers=$(wc -l < "${mod}"); echo "${mod} : $line_numbers"; [[ $line_numbers -gt 500 ]] && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo "All modules are good" && exit 0 || exit 1

.github/workflows/restat_desktop_cc_checker_build.yml

@@ -1,31 +1,38 @@
-name: restat-desktop C++ CI
+name: restatdesk build checker
 on:
   push:
     branches: [ master ]
     paths:
-      - 'sw/restat-desktop/**'
+      - 'sw/restatdesk/**/*.cc'
+      - 'sw/restatdesk/**/*.h'
   pull_request:
     branches: [ master ]
     paths:
-      - 'sw/restat-desktop/**'
+      - 'sw/restatdesk/**/*.cc'
+      - 'sw/restatdesk/**/*.h'
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: install GTK--
+    - name: install gtkmm
       id: install_gtkmm
       run: |
         sudo apt-get update
-        sudo apt-get install jq
-        sudo apt-get install libgtkmm-3.0-dev
+        sudo apt-get upgrade -y
+        sudo apt-get install -y pkg-config
+        sudo apt-get install -y libserial-dev
+        sudo apt-get install -y libgtkmm-3.0-dev
+        sudo apt-get install -y libgtk-4-dev
+        sudo apt-get install -y software-properties-common
+        sudo apt-get install -y libgtkmm-4.0-dev
     - name: make all
       id: gnu_make_all
       run: |
-        cd sw/restat-desktop/build
+        cd sw/restatdesk/build
         make all
     - name: make clean
       id: gnu_make_clean
       run: |
-        cd sw/restat-desktop/build
+        cd sw/restatdesk/build
         make clean

.github/workflows/restat_toc.yml

@@ -0,0 +1,25 @@
+name: restat toc
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - '**.md'
+  pull_request:
+    branches: [ master ]
+    paths:
+      - '**.md'
+
+permissions:
+  contents: write
+
+jobs:
+  generateTOC:
+    name: restat toc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Generate TOC
+        uses: technote-space/toc-generator@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,87 @@
+# ==========================================
+# 1. Global & Common Ignores
+# ==========================================
+
+# OS Metadata
+.DS_Store
+Thumbs.db
+*~
+*.swp
+*.swo
+
+# Compiler & Build Artifacts (Generic)
+*.o
+*.obj
+*.a
+*.lib
+*.so
+*.dylib
+*.dll
+*.d
+*.slo
+*.lo
+*.gch
+*.pch
+*.mod
+*.smod
+*.lai
+*.la
+*.exe
+*.out
+*.app
+*.lss
+core
+
+# Development Caches & Local Configurations
+.cache/
+.clangd
+.idea/
+.vs/
+*.pfx
+
+# Python generic ignores
 __pycache__/
 *.py[cod]
-*.o
+*.pyi
+.venv/
+venv/
+ENV/
+env/
+
+# CMake generic ignores
+CMakeCache.txt
+CMakeFiles/
+CMakeScripts/
+Testing/
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps/
+CPackConfig.cmake
+CPackSourceConfig.cmake
+CTestConfig.cmake
+
+
+# ==========================================
+# 2. Sub-project Ignores (Software - sw/)
+# ==========================================
+
+### sw/restat_base
+sw/restat_base/build/
+
+### sw/restatdesk
+sw/restatdesk/build/
+sw/restatdesk/resources.cc
+
+
+# ==========================================
+# 3. Sub-project Ignores (Hardware - hw/)
+# ==========================================
+
+# KiCad / CAD backups and local caches
+hw/**/*.kicad_pcb-bak
+hw/**/*.sch-bak
+hw/**/fp-info-cache
+hw/**/*-backups/