9 Commits
2 changed files with 12 additions and 13 deletions

No files matched your search

+2 -2
View File
@@ -52,9 +52,9 @@ jobs:
uses: peaceiris/actions-gh-pages@v3 uses: peaceiris/actions-gh-pages@v3
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html publish_dir: docs/sphinx
publish_branch: gh-pages publish_branch: gh-pages
destination_dir: docs/sphinx/build destination_dir: sphinx
deploy-dev: deploy-dev:
if: github.ref == 'refs/heads/dev' # Only deploy on 'dev' branch if: github.ref == 'refs/heads/dev' # Only deploy on 'dev' branch
+10 -11
View File
@@ -16,11 +16,10 @@ Features
- Pre-compiled software available and flashable via USB using your regular file explorer - Pre-compiled software available and flashable via USB using your regular file explorer
- Debugging via Serial Wire Debug or optional logging via stdio and UART/USB serial port - Debugging via Serial Wire Debug or optional logging via stdio and UART/USB serial port
Getting Started Getting Started & Documentation
------------ ------------
The [documentation](https://gab-k.github.io/RP2040-Decoder/) provides an overview of the steps required to use the decoder. It also tries to give an insight into how the hardware and software works.
The ["Getting Started"](https://github.com/gab-k/RP2040-Decoder/wiki/Getting-started) page provides an overview of the steps required to use the decoder as well as brief instructions for all the necessary steps.
License License
@@ -29,17 +28,17 @@ License
- Hardware - CERN Open Hardware Licence Version 2 - Permissive - Hardware - CERN Open Hardware Licence Version 2 - Permissive
- [LICENSE](https://github.com/gab-k/RP2040-Decoder/blob/main/LICENSE) - [LICENSE](https://github.com/gab-k/RP2040-Decoder/blob/main/LICENSE)
------------
Further details about the project can be found here: [RP2040-Decoder Wiki](https://github.com/gab-k/RP2040-Decoder/wiki)
Note: The decoder is still in early development, there might (will) be bugs as its not tested that much yet.
So suggestions on how to improve things and bug reports are always much appreciated.
The wiki is also work in progress and will be updated to be as comprehensive as possible.
------------ ------------
Rev 1.0
<div style="display: flex; justify-content: space-between; align-items: center;"> <div style="display: flex; justify-content: space-between; align-items: center;">
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img/top.png" alt="Image 1" style="width: 50%;"/> <img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img_rev_1_0/top.png" alt="Image 1" style="width: 45%;"/>
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img/bottom.png" alt="Image 2" style="width: 50%;"/> <img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img_rev_1_0/bottom.png" alt="Image 2" style="width: 45%;"/>
</div> </div>
Rev 0.3
<div style="display: flex; justify-content: space-between; align-items: center;">
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img_rev_0_3/top.png" alt="Image 1" style="width: 45%;"/>
<img src="https://raw.githubusercontent.com/gab-k/RP2040-Decoder/refs/heads/gh-pages-dev/img_rev_0_3/bottom.png" alt="Image 2" style="width: 45%;"/>
</div>