Update docs and build/release action

Author: gab-k

.github/workflows/build_sw.yml

@@ -40,9 +40,6 @@ jobs:
       # Build your program with the given configuration
       run: cmake --build ${{github.workspace}}/Software/build --config ${{env.BUILD_TYPE}}
 
-    - name: ls2
-      run: ls ${{github.workspace}}/Software/build
-
     - name: Upload build files as artifact
       uses: actions/upload-artifact@v4
       with:
@@ -53,14 +50,24 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+      - name: Download build files artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build_files
+          
+      - name: Display structure of downloaded files
+        run: ls -R
+          
       - name: Release
         uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            README.md
-            LICENSE
+            RP2040-Decoder.bin
+            RP2040-Decoder.dis
+            RP2040-Decoder.elf
+            RP2040-Decoder.elf.map
+            RP2040-Decoder.hex
+            RP2040-Decoder.uf2
     
 

docs/sphinx/source/other/getting_started.rst

@@ -4,7 +4,7 @@ Getting started
 1. Where to get the board?
 ----------------------------------
 
-You can choose any PCB manufacturer you like.The PCB is designed to fit with JLCPCB.com's capabilities and constraints.You can assemble the board yourself, but it's best not to do so if you're not familiar with soldering small components. Alternatively, you can order the board fully or partly assembled.Soldering the back of the PCB by hand is not too difficult. All parts are normally available at LCSC.com, who supply parts to JLCPCB.com.
+You can choose any PCB manufacturer you like. The PCB is designed to fit with JLCPCB.com's capabilities and constraints. You can assemble the board yourself, but it's best not to do so if you're not familiar with soldering small components. Alternatively, you can order the board fully or partly assembled. Soldering the back of the PCB by hand is not too difficult. All parts are normally available at LCSC.com, who supply parts to JLCPCB.com.
 
 2. Production files?
 ----------------------------------
@@ -30,7 +30,7 @@ Note: If you are building for Hardware Rev 0.3 or below change the board definti
 
 For RP2040-Decoders with USB there is two ways of flashing the software:
 
-1. Flasing via USB using the .uf2 file by copying it with your preferred file explorer. 
+1. Flashing via USB using the .uf2 file by copying it with your preferred file explorer. 
 2. Using Serial Wire Debug (SWD)
 
    2.1. Using another RP2040/RP2350-based board with `debugprobe software <https://github.com/raspberrypi/debugprobe>`_ on it. (Could be the RP2040-Decoder itself)

docs/sphinx/source/software/sw_description.rst

@@ -19,12 +19,12 @@ Software files high level overview:
 
 - **shared.c / shared.h** (used by both cores)
 
-- Error handling
-- Helper functions for retrieving CV's
+   - Error handling
+   - Helper functions for retrieving CV's
 
 - **CV.h**
 
-- Default configuration variables
+   - Default configuration variables
 
 - **CMakeLists.txt**
 
@@ -35,7 +35,7 @@ Software files high level overview:
    - Debug logging configuration (via stdio using UART/USB)
    - Linked libraries
 
-- **RP2040-Decoder-board.h or RP2040-Decoder-board-legacy.h**
+- **RP2040-Decoder-board-Rev-X_Y.h**
 
    - Flash Size
    - Pin definitions