Skip to content

Commit 62e892d

Browse files
Add link to the docs in the README and include it in the release archive
1 parent 47ac424 commit 62e892d

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ jobs:
6868

6969
- name: Prepare Build Artifacts (!windows)
7070
working-directory: ./${{ env.DIST_DIR }}
71-
run: tar -czf ${{ env.RELEASE_NAME }}.tar.gz arduino-flasher-cli -C ../ LICENSE
71+
run: tar -czf ${{ env.RELEASE_NAME }}.tar.gz arduino-flasher-cli -C ../ LICENSE README.md
7272
if: matrix.os != 'windows'
7373

7474
- name: Prepare Build Artifacts (windows)
7575
working-directory: ./${{ env.DIST_DIR }}
76-
run: 7z a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe ../LICENSE
76+
run: 7z a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe ../LICENSE ../README.md
7777
if: matrix.os == 'windows'
7878

7979
- name: Upload artifacts

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22

33
A tool to download and flash Debian images on the board.
44

5+
## Docs
6+
7+
For a full guide on how to use it, see the [User documentation](https://docs.arduino.cc/tutorials/uno-q/update-image/).
8+
59
## Build and test it locally
610

7-
Build it with `task arduino-flasher-cli:build` and run:
11+
Build it with `task build` and run:
812

913
```sh
1014
# Flash the latest release of the Debian image

0 commit comments

Comments
 (0)