jlanders/chip8-em
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more readme changes

Browse Source
This commit is contained in:
Cole Landers
2026-01-31 16:20:56 -06:00
parent 342eb4557d
commit fed6762288
1 changed files with 24 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -67,12 +67,8 @@
![Chip8 Emulator Screen Shot][product-screenshot]
Here's a blank template to get started. To avoid retyping too much info, do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`, `project_license`
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
* [![Rust][Rust]][Rust-url]
@@ -82,43 +78,47 @@ Here's a blank template to get started. To avoid retyping too much info, do a se
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
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.
* npm
```sh
* rust - Follow the official install guide [here](https://rust-lang.org/tools/install/)
<!-- ```sh
npm install npm@latest -g
```
``` -->
### Installation
1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
1. Clone the repo
```sh
git clone https://git.colelanders.dev/jlanders/chip8-em.git
```
3. Install NPM packages
2. Navigate to the repo directory
```sh
npm install
cd chip8-em
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
5. Change git remote url to avoid accidental pushes to base project
3. Build the project
```sh
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
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**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -126,7 +126,8 @@ This is an example of how to list things you need to use the software and how to
<!-- USAGE EXAMPLES -->
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
**WIP**
<!-- Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. -->
<!-- _For more examples, please refer to the [Documentation](https://example.com)_ -->