From fed6762288919aa381f018742a1709e20a3da9d2 Mon Sep 17 00:00:00 2001 From: Cole Landers Date: Sat, 31 Jan 2026 16:20:56 -0600 Subject: [PATCH] more readme changes --- README.md | 47 ++++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f9a7b0f..dd040ad 100644 --- a/README.md +++ b/README.md @@ -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` -

(back to top)

- - ### 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

(back to top)

- - ## 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/) + ### 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** + +

(back to top)

@@ -126,7 +126,8 @@ This is an example of how to list things you need to use the software and how to ## 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** +