Update docs and build/release action

This commit is contained in:
gab-k committed 2025-01-02 09:20:46 +01:00
1 parent ad888dd4a0
commit 21bee73f01
3 files changed
+16 -9

No files matched your search

+14 -7
View File
@@ -40,9 +40,6 @@ jobs:
# Build your program with the given configuration # Build your program with the given configuration
run: cmake --build ${{github.workspace}}/Software/build --config ${{env.BUILD_TYPE}} 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 - name: Upload build files as artifact
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:
@@ -53,14 +50,24 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: build needs: build
steps: steps:
- name: Checkout - name: Download build files artifact
uses: actions/checkout@v4 uses: actions/download-artifact@v4
with:
name: build_files
- name: Display structure of downloaded files
run: ls -R
- name: Release - name: Release
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/') if: startsWith(github.ref, 'refs/tags/')
with: with:
files: | files: |
README.md RP2040-Decoder.bin
LICENSE RP2040-Decoder.dis
RP2040-Decoder.elf
RP2040-Decoder.elf.map
RP2040-Decoder.hex
RP2040-Decoder.uf2
+1 -1
View File
@@ -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: 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. 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) 2.1. Using another RP2040/RP2350-based board with `debugprobe software <https://github.com/raspberrypi/debugprobe>`_ on it. (Could be the RP2040-Decoder itself)
@@ -35,7 +35,7 @@ Software files high level overview:
- Debug logging configuration (via stdio using UART/USB) - Debug logging configuration (via stdio using UART/USB)
- Linked libraries - Linked libraries
- **RP2040-Decoder-board.h or RP2040-Decoder-board-legacy.h** - **RP2040-Decoder-board-Rev-X_Y.h**
- Flash Size - Flash Size
- Pin definitions - Pin definitions