Add README for quick start on Mac

more-targets^2
Titan Yuan 2024-09-27 17:36:02 -07:00
parent f15ab47842
commit df54c734b3
1 changed files with 26 additions and 5 deletions

View File

@ -2,7 +2,29 @@
![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
## 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 +41,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 +76,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 +87,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: