Skip to content

Commit

Permalink
Add README for quick start on Mac
Browse files Browse the repository at this point in the history
  • Loading branch information
tryuan99 committed Sep 28, 2024
1 parent f15ab47 commit df54c73
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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).

Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -90,4 +111,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)

0 comments on commit df54c73

Please sign in to comment.