documentation on how to download action builds

jankae · Mar 3, 2024 · a7aae7e · a7aae7e
1 parent e93e364
commit a7aae7e
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 1 deletion.
diff --git a/Documentation/DeveloperInfo/DownloadActionBuilds.md b/Documentation/DeveloperInfo/DownloadActionBuilds.md
@@ -0,0 +1,17 @@
+# Download automatically build binaries
+
+The Github actions are set up in such a way that binary files are created for each commit on the master branch. Feel free to try them out if you want the latest features but be prepared to find some unfinished things in them as well.
+
+## Finding the binaries
+
+1. Switch to the `Actions` tab in the repository:
+   ![Binaries1](Screenshots/Binaries1.png)
+2. Each commit will trigger two workflow runs, one for the binaries and one for some automated tests. Pick a commit and chose the workflow run with the higher build number:
+   ![Binaries2](Screenshots/Binaries2.png)
+3. The next window should look like this:
+   ![Binaries3](Screenshots/Binaries3.png)
+   If it looks like this instead, you have picked the test workflow run (which does not contain any binaries):
+   ![Binaries4](Screenshots/Binaries4.png)
+4. Scroll down to find the binaries:
+   ![Binaries5](Screenshots/Binaries5.png)
+5. Click on an artifact to download it. If that doesn't seem to work, check that you are logged in on Github (required for the download)
diff --git a/Documentation/DeveloperInfo/Screenshots/Binaries1.png b/Documentation/DeveloperInfo/Screenshots/Binaries1.png
diff --git a/Documentation/DeveloperInfo/Screenshots/Binaries2.png b/Documentation/DeveloperInfo/Screenshots/Binaries2.png
diff --git a/Documentation/DeveloperInfo/Screenshots/Binaries3.png b/Documentation/DeveloperInfo/Screenshots/Binaries3.png
diff --git a/Documentation/DeveloperInfo/Screenshots/Binaries4.png b/Documentation/DeveloperInfo/Screenshots/Binaries4.png
diff --git a/Documentation/DeveloperInfo/Screenshots/Binaries5.png b/Documentation/DeveloperInfo/Screenshots/Binaries5.png
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ cd $UNPACKED_ZIP_FOLDER$
 
 ## Quick Start
 * You can find released versions of the GUI application and the device firmware [here](https://github.com/jankae/LibreVNA/releases).
-* If you would like to try out the newest features, the compiled versions of each commit can be found [here](https://github.com/jankae/LibreVNA/actions) (but keep in mind that some features might be unstable or incomplete).
+* If you would like to try out the newest features, the compiled versions of each commit can be found [here](https://github.com/jankae/LibreVNA/actions) (but keep in mind that some features might be unstable or incomplete). If you are having trouble downloading them, please refer to this [guide](Documentation/DeveloperInfo/DownloadActionBuilds.md).
 * An (incomplete) [user manual](Documentation/UserManual/manual.pdf) is also available.
 * If you would like to control the LibreVNA with a script, see the [SCPI Programming Guide](Documentation/UserManual/ProgrammingGuide.pdf).