## Getting Started
You can find pre-built binaries for Windows/MacOS/Linux -> [releases](https://git.colelanders.dev/jlanders/chip8-em/releases)
To run the code get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* rust - Follow the official install guide [here](https://rust-lang.org/tools/install/)
### Installation
1. Clone the repo
```sh
git clone https://git.colelanders.dev/jlanders/chip8-em.git
```
2. Navigate to the repo directory
```sh
cd chip8-em
```
3. Build the project
```sh
cargo build
```
### Running
Choose the method that best fits your needs. If you just want to use the emulator, I recommend using the **Pre-built Binaries**.
#### ๐ Option 1: Pre-built Binaries (Fastest)
**WIP**
#### ๐ ๏ธ Option 2: Build Locally (From Source)
**WIP**
## Contributing
Since this is a personal project, this specific repo is not open for contributions. However, please feel free to clone the project and use it as you wish!
## License
Distributed under the MIT License. See `LICENSE` for more information.