Merge pull request #1 from cybergear-robotics/feature/actions

add badges and CI

.github/workflows/build_example.yml

@@ -0,0 +1,26 @@
+name: Build examples
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+jobs:
+  build-examples:
+    name: Build for ${{ matrix.idf_target }} on ${{ matrix.idf_ver }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        idf_ver: ["release-v5.2"]
+        idf_target: ["esp32s3"]
+        example_project: ["position_test"]
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+    - name: Build Examples
+      uses: espressif/esp-idf-ci-action@v1
+      with:
+        esp_idf_version: ${{ matrix.idf_ver }}
+        target: ${{ matrix.idf_target }}
+        path: examples/${{ matrix.example_project }}

.github/workflows/esp_upload_component.yml

@@ -0,0 +1,20 @@
+name: Upload component to Espressif Component Service
+
+# If the commit is tagged, it will be uploaded. Other scenario silently fail.
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  upload_components:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Upload component to component registry
+        uses: espressif/upload-components-ci-action@v1
+        with:
+          namespace: "cybergear-robotics"
+          name: "cybergear"
+          version: ${{ github.ref_name }}
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

README.md

@@ -1,5 +1,12 @@
 # Xiaomi CyberGear Driver
 
+[![Examples build](https://github.com/cybergear-robotics/cybergear/actions/workflows/build_example.yml/badge.svg)](https://github.com/cybergear-robotics/cybergear/actions/workflows/build_example.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
+[![Framework](https://img.shields.io/badge/Framework-ESP_IDF-orange.svg)](https://shields.io/)
+[![Language](https://img.shields.io/badge/Language-C-purple.svg)](https://shields.io/)
+
+
 This driver uses Espressif's TWAI (Two-Wire Automotive Interface) in 
 order to communicate with Xiamoi CyberGear motors. It bases on the library 
 [Xiaomi_CyberGear_Arduino](https://github.com/DanielKalicki/Xiaomi_CyberGear_Arduino) 
@@ -9,7 +16,7 @@ and is ported for ESP-IDF.
 
 This library does not use error logs/prints, but instead every internal error is 
 passed through. Therefore each relevant function returns `esp_err_t`, which should
-be interpreted. During development `ESP_ERROR_CHECK(...)` helps, but due to the strength
+be handled. During development `ESP_ERROR_CHECK(...)` helps, but due to the strength
 of these motors, an error should be resolved or the motors should be stopped by an 
 external emergency mechanism.