Merge remote-tracking branch 'origin/master' into more-targets

.github/workflows/build.yaml

@@ -1,12 +1,12 @@
-name: Build project
+name: Build
 
 on:
-    push:
+  push:
-      branches:
+    branches:
-        - release
+      - release
-    pull_request:
+  pull_request:
-      branches:
+    branches:
-        - release
+      - release
 
 jobs:
   buildForAllSupportedPlatforms:
@@ -45,4 +45,4 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: Build-${{ matrix.targetPlatform }}
-          path: build/${{ matrix.targetPlatform }}
+          path: build/${{ matrix.targetPlatform }}

.github/workflows/release.md

@@ -0,0 +1,27 @@
+# micromissiles-unity
+
+## Build ${{ github.ref }}
+
+## Instructions
+
+Download and extract the archive corresponding to your platform (Windows or Mac) from the binaries listed below.
+
+## Windows
+
+1. Download the zip file for Windows: `micromissiles-${{ github.ref }}-windows_x86_64.zip`.
+2. Unzip the zip file. The zip file should contain a single directory called `micromissiles-${{ github.ref }}-windows_x86_64`.
+3. Run `micromissiles-<version>-StandaloneWindows64.exe`.
+
+## Mac
+
+1. Download the zip file for Darwin: `micromissiles-${{ github.ref }}-darwin.zip`.
+2. Unzip the zip file. The zip file should contain a single app file.
+3. Change the permission of the app file recursively by running:
+   ```bash
+   chmod -R +x micromissiles-<version>-StandaloneOSX.app
+   ```
+4. Open the app file.
+5. If you get a warning that Apple cannot check the application for malicious software:
+     * Open `System Preferences`.
+     * Navigate to `Privacy & Security`.
+     * Click on `Open Anyway` to bypass Apple's developer check.

.github/workflows/release.yaml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  workflow_run:
+      workflows: ['Build']
+      types: [completed]
+      branches:
+          - release
+
+jobs:
+  build:
+    name: Create release
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Create release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body_path: .github/workflows/release.md
+          draft: false
+          prerelease: false

README.md

@@ -2,7 +2,33 @@
 
 ![Sim Salvo Animation](docs/images/sim_salvo_animation.gif)
 
-# Getting started **developing** micromissiles-unity 
+# Quick Start
+
+We generate pre-built standalone binaries for Windows and Mac users from the `release` branch. These binaries are intended for non-development users who just want to run the application and modify a few configurations along the way.
+
+You can find the latest release [here](https://github.com/PisterLab/micromissiles-unity/releases/latest).
+
+## Windows
+
+1. Download the zip file for Windows: `micromissiles-<version>-windows_x86_64.zip`.
+2. Unzip the zip file. The zip file should contain a single directory called `micromissiles-<version>-windows_x86_64`.
+3. Run `micromissiles-<version>-StandaloneWindows64.exe`.
+
+## Mac
+
+1. Download the zip file for Darwin: `micromissiles-<version>-darwin.zip`.
+2. Unzip the zip file. The zip file should contain a single app file.
+3. Change the permission of the app file recursively by running:
+   ```bash
+   chmod -R +x micromissiles-<version>-StandaloneOSX.app
+   ```
+4. Open the app file.
+5. If you get a warning that Apple cannot check the application for malicious software:
+     * Open `System Preferences`.
+     * Navigate to `Privacy & Security`.
+     * Click on `Open Anyway` to bypass Apple's developer check.
+
+# Development
 
 This guide will help you set up and run the project in development mode. You'll learn how to install Unity Hub, open the project, and navigate the main scene.
 
@@ -19,7 +45,7 @@ This guide will help you set up and run the project in development mode. You'll
 
 ## Prerequisites
 
-- A computer with internet access ;)
+- A computer with internet access.
 - Administrative privileges to install software.
 - [Git](https://git-scm.com/downloads) installed on your system (optional, for cloning the repository).
 
@@ -54,7 +80,7 @@ Alternatively, you can download the repository as a ZIP file and extract it to a
    - Navigate to the **"Projects"** tab.
    - Click on the **"ADD"** button.
    - Browse to the folder where you cloned or extracted the project.
-   - Select the folder containing the `Assets` folder and click **"Select Folder"**.
+   - Select the folder containing the `Assets` folder and click on **"Select Folder"**.
 
 3. **Install the Required Unity Version**:
    - Unity Hub will detect if the project requires a Unity version that is not currently installed.
@@ -65,7 +91,6 @@ Alternatively, you can download the repository as a ZIP file and extract it to a
 4. **Open the Project**:
    - Once the required Unity version is installed, click on the project name in Unity Hub to open it.
 
-
 ### 4. Open the Main Scene
 
 After the project opens in Unity:
@@ -90,4 +115,4 @@ After the project opens in Unity:
 ## Additional Resources
 
 - [Keybinds and Controls](docs/Keybinds_and_Controls.md)
-- [Simulation Configuration Guide](docs/Simulation_Config_Guide.md)
+- [Simulation Configuration Guide](docs/Simulation_Config_Guide.md)