diff --git a/.github/workflows/release-binaries.yaml b/.github/workflows/release-binaries.yaml index 29c1593..0fa2f4f 100644 --- a/.github/workflows/release-binaries.yaml +++ b/.github/workflows/release-binaries.yaml @@ -21,25 +21,25 @@ jobs: uses: actions/download-artifact@v4 with: name: ${{ env.ARTIFACT_NAME }} - - name: Verify artifact download (Debugging) - run: ls -R +# - name: Verify artifact download (Debugging) +# run: ls -R - name: Archive binaries uses: thedoctor0/zip-release@master with: filename: ${{ env.ARTIFACT_NAME }}.zip - - name: Verify artifact archive (Debugging) - run: ls -R +# - name: Verify artifact archive (Debugging) +# run: ls -R - name: Get release URL id: get-release uses: bruceadams/get-release@v1.3.2 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} -# - name: Upload binaries as release assets -# uses: actions/upload-release-asset@v1.0.2 -# env: -# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} -# with: -# upload_url: ${{ steps.get-release.outputs.upload_url }} -# asset_path: ./${{ env.ARTIFACT_NAME }}.zip -# asset_name: ./${{ env.ARTIFACT_NAME }}.zip -# asset_content_type: application/zip \ No newline at end of file + - name: Upload binaries as release assets + uses: actions/upload-release-asset@v1.0.2 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ steps.get-release.outputs.upload_url }} + asset_path: ./${{ env.ARTIFACT_NAME }}.zip + asset_name: ${{ env.ARTIFACT_NAME }}.zip + asset_content_type: application/zip \ No newline at end of file diff --git a/README.md b/README.md index 153f272..2095e8b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Microcontroller firmware for MTspin; a motorised rotating display stand. +![MTspin demo](images/mtspin%20demo%20426%20x%20240%20gif.gif) + ## Introduction ### Microcontroller @@ -48,10 +50,10 @@ As with any other Arduino project, you can simply download the project and open OR -You work without an IDE by making use of the provided setup/build scripts and/or Arduino CLI. You can run the setup/build scripts to automatically install the required libraries, and build/compile/upload the project as described in the following sections. +You can work without an IDE by making use of the provided setup/build scripts and/or Arduino CLI. You can run the setup/build scripts to automatically install the required libraries, and build/compile/upload the project as described in the following sections. This method will build the project for all boards defined in [arduino-boards.txt](arduino-boards.txt). > [!NOTE] -> Running the setup/build scripts will install arduino-cli and other dependencies (Arduino cores and libraries) on your device. +> Running the setup/build scripts will install arduino-cli and other dependencies (Arduino cores and libraries) on your device. Cores are extracted from the required boards defined in [arduino-boards.txt](arduino-boards.txt) and required libraries are defined in [arduino-libs.txt](arduino-libs.txt). ### Setup and build scripts for Windows @@ -169,7 +171,7 @@ For Linux: ## System control and logging/status reporting -The project provides a means of controlling the system and interrogating the status of the system via serial messages once, the programme is uploaded to the Arduino board. The following messages are implemented: +The project provides a means of controlling the system and interrogating the status of the system via serial messages, once the programme is uploaded to the Arduino board. The following messages are implemented: |Message|Action| |:----:|----| diff --git a/images/mtspin demo 426 x 240 gif.gif b/images/mtspin demo 426 x 240 gif.gif new file mode 100644 index 0000000..deab65b Binary files /dev/null and b/images/mtspin demo 426 x 240 gif.gif differ