Add link to the docs in the README and include it in the release archive

Author: MatteoPologruto

.github/workflows/release.yml

@@ -68,12 +68,12 @@ jobs:
 
       - name: Prepare Build Artifacts (!windows)
         working-directory: ./${{ env.DIST_DIR }}
-        run: tar -czf ${{ env.RELEASE_NAME }}.tar.gz arduino-flasher-cli -C ../ LICENSE
+        run: tar -czf ${{ env.RELEASE_NAME }}.tar.gz arduino-flasher-cli -C ../ LICENSE README.md
         if: matrix.os != 'windows'
 
       - name: Prepare Build Artifacts (windows)
         working-directory: ./${{ env.DIST_DIR }}
-        run: 7z a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe ../LICENSE
+        run: 7z a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe ../LICENSE ../README.md
         if: matrix.os == 'windows'
 
       - name: Upload artifacts
@@ -125,7 +125,7 @@ jobs:
 
       - name: Prepare Build Artifacts
         run: |
-          ${{ env.SEVENZ_PATH }} a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe LICENSE
+          ${{ env.SEVENZ_PATH }} a -tzip ${{ env.RELEASE_NAME }}.zip arduino-flasher-cli.exe LICENSE README.md
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
@@ -137,7 +137,7 @@ jobs:
 
       # This step is needed because the self hosted runner does not delete files automatically
       - name: Cleanup
-        run: rm ${{ env.RELEASE_NAME }}.zip LICENSE arduino-flasher-cli.exe
+        run: rm ${{ env.RELEASE_NAME }}.zip LICENSE README.md arduino-flasher-cli.exe
 
   notarize-macos:
     name: Notarize macOS
@@ -253,7 +253,7 @@ jobs:
             +x \
             "${{ env.PROJECT_NAME }}"
 
-          tar -czf ${{ env.PACKAGE_FILENAME }} ${{ env.PROJECT_NAME }} LICENSE
+          tar -czf ${{ env.PACKAGE_FILENAME }} ${{ env.PROJECT_NAME }} LICENSE README.md
 
       - name: Replace artifact with notarized build
         uses: actions/upload-artifact@v4

README.md

@@ -2,9 +2,13 @@
 
 A tool to download and flash Debian images on the board.
 
+## Docs
+
+For a full guide on how to use it, see the [User documentation](https://docs.arduino.cc/tutorials/uno-q/update-image/).
+
 ## Build and test it locally
 
-Build it with `task arduino-flasher-cli:build` and run:
+Build it with `task build` and run:
 
 ```sh
 # Flash the latest release of the Debian image