tutorial: readme

.github/workflows/ci.yml

@@ -71,7 +71,7 @@ jobs:
           docker run \
             --rm \
             --platform linux/amd64 \
-            --workdir /builder/mnt/test/unittest \
+            --workdir /builder/mnt/tests/unittest \
             -v ${{ github.workspace }}:/builder/mnt \
             cproject-builder:latest \
             /bin/bash -c "ceedling clobber; ceedling gcov:all; ceedling utils:gcov"
@@ -81,7 +81,7 @@ jobs:
         run: |
           staging="reports-${{github.run_number}}"
           mkdir -p "$staging"
-          cp -r test/unittest/build/artifacts/gcov "$staging"
+          cp -r tests/unittest/build/artifacts/gcov "$staging"
           tar czf "$staging.tar.gz" "$staging"
           echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
       -

.gitignore

@@ -23,7 +23,7 @@ go.sum
 **/parking
 
 test/**/build/
-# test/unittest/generated
+# tests/unittest/generated
 
 compile_commands.json
 # FIXME: remove this in case you want this to be available for everyone.

clang-format.json

@@ -1,5 +1,5 @@
 {
-  "paths": ["./src/**/*.[ch]", "./include/**/*.[ch]", "./test/unittest/test/*.[ch]"],
+  "paths": ["./src/**/*.[ch]", "./include/**/*.[ch]", "./tests/unittest/test/*.[ch]"],
   "filterPre": [".*"],
-  "filterPost": ["./src/build/**", "./test/unittest/build/**", "./test/unittest/generated"]
+  "filterPost": ["./src/build/**", "./tests/unittest/build/**", "./tests/unittest/generated"]
 }

readme.md

@@ -0,0 +1,12 @@
+
+# Dummy C Project
+
+[![Build status](https://github.com/lmapii/pkt/workflows/ci/badge.svg)](https://github.com/lmapii/pkt/actions)
+
+Repository for a containerised empty C library project including:
+
+- Static code analysis with `clang-tidy`
+- Code formatting using `clang-format`
+- Unit tests using `unity` and `ceedling`
+- Containerized GitHub actions.
+