micromissiles-unity/README.md

# micromissiles-unity

![Sim Salvo Animation](docs/public/images/sim_salvo_animation.gif)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PisterLab/micromissiles-unity/build.yaml?link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Factions%2Fworkflows%2Fbuild.yaml)](https://github.com/PisterLab/micromissiles-unity/actions/workflows/build.yaml)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PisterLab/micromissiles-unity/test.yaml?label=tests&link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Factions%2Fworkflows%2Ftest.yaml)](https://github.com/PisterLab/micromissiles-unity/actions/workflows/test.yaml)
[![GitHub Release](https://img.shields.io/github/v/release/PisterLab/micromissiles-unity?link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Freleases%2Flatest)](https://github.com/PisterLab/micromissiles-unity/releases/latest)
[![Static Badge](https://img.shields.io/badge/documentation-page?label=Docs)](https://pisterlab.github.io/micromissiles-unity/)

# Documentation 

Documentation is hosted on the [micromissiles-unity GitHub Pages site](https://pisterlab.github.io/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. In the `micromissiles-<version>-windows_x86_64` directory, run `micromissiles-<version>-StandaloneWindows64.exe`.

## Mac

1. Download the tarball file for Darwin: `micromissiles-<version>-darwin.tar.gz`.
2. Untar the tarball. The tarball should contain a single directory called `micromissiles-<version>-darwin`.
3. In the `micromissiles-<version>-darwin` directory, run the app file.
4. 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.
Add documentation 2024-09-24 17:34:30 -07:00			`# micromissiles-unity`

Update image locations 2024-10-02 00:51:06 -07:00			`![Sim Salvo Animation](docs/public/images/sim_salvo_animation.gif)`
Add GIF, tune autoplay parameters 2024-09-24 22:01:15 -07:00
Fix links in README 2024-09-30 03:52:14 -07:00			`[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PisterLab/micromissiles-unity/build.yaml?link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Factions%2Fworkflows%2Fbuild.yaml)](https://github.com/PisterLab/micromissiles-unity/actions/workflows/build.yaml)`
			`[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PisterLab/micromissiles-unity/test.yaml?label=tests&link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Factions%2Fworkflows%2Ftest.yaml)](https://github.com/PisterLab/micromissiles-unity/actions/workflows/test.yaml)`
			`[![GitHub Release](https://img.shields.io/github/v/release/PisterLab/micromissiles-unity?link=https%3A%2F%2Fgithub.com%2FPisterLab%2Fmicromissiles-unity%2Freleases%2Flatest)](https://github.com/PisterLab/micromissiles-unity/releases/latest)`
Add Simulation_Logging guide, reorg docs for dev guide 2024-10-02 13:12:12 -07:00			`[![Static Badge](https://img.shields.io/badge/documentation-page?label=Docs)](https://pisterlab.github.io/micromissiles-unity/)`
Update README.md 2024-09-30 03:45:16 -07:00
Add Simulation_Logging guide, reorg docs for dev guide 2024-10-02 13:12:12 -07:00			`# Documentation`
Update README.md 2024-09-30 03:39:34 -07:00
Add Simulation_Logging guide, reorg docs for dev guide 2024-10-02 13:12:12 -07:00			`Documentation is hosted on the [micromissiles-unity GitHub Pages site](https://pisterlab.github.io/micromissiles-unity/).`
Update README.md 2024-09-30 03:39:34 -07:00
Add README for quick start on Mac 2024-09-27 17:36:02 -07:00			`# 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`

Add release action 2024-09-27 18:01:17 -07:00			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. In the `micromissiles-<version>-windows_x86_64` directory, run `micromissiles-<version>-StandaloneWindows64.exe`.

Add README for quick start on Mac 2024-09-27 17:36:02 -07:00			`## Mac`

Add release action 2024-09-27 18:01:17 -07:00			1. Download the tarball file for Darwin: `micromissiles-<version>-darwin.tar.gz`.
			2. Untar the tarball. The tarball should contain a single directory called `micromissiles-<version>-darwin`.
			3. In the `micromissiles-<version>-darwin` directory, run the app file.
			`4. If you get a warning that Apple cannot check the application for malicious software:`
Add README for quick start on Mac 2024-09-27 17:36:02 -07:00			* Open `System Preferences`.
			* Navigate to `Privacy & Security`.
			* Click on `Open Anyway` to bypass Apple's developer check.