From 124493fd118172e7188cc824d5be0b1e9bf2da83 Mon Sep 17 00:00:00 2001 From: Cole Landers Date: Sat, 31 Jan 2026 16:00:54 -0600 Subject: [PATCH] pushing readme changes to view --- README.md | 97 +++++++++++++++++++------------------------------------ 1 file changed, 33 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 473dd06..5b100a7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,4 @@ - - @@ -24,7 +16,7 @@
- + Logo @@ -33,14 +25,10 @@

Chip8 Emulator built in Rust.
- Explore the docs » +
-
- View Demo - · - Report Bug - · - Request Feature + View Demo

@@ -53,7 +41,7 @@
  • About The Project
  • @@ -77,7 +65,7 @@ ## About The Project -[![Product Name Screen Shot][product-screenshot]](https://example.com) +[![Product Name 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` @@ -87,14 +75,10 @@ Here's a blank template to get started. To avoid retyping too much info, do a se ### Built With -* [![Next][Next.js]][Next-url] -* [![React][React.js]][React-url] -* [![Vue][Vue.js]][Vue-url] -* [![Angular][Angular.io]][Angular-url] -* [![Svelte][Svelte.dev]][Svelte-url] -* [![Laravel][Laravel.com]][Laravel-url] -* [![Bootstrap][Bootstrap.com]][Bootstrap-url] -* [![JQuery][JQuery.com]][JQuery-url] +* [![Rust][Rust]][Rust-url] +* [![Raylib][Raylib]][Raylib-url] +* [![Clap][Clap]][Clap-url] +* [![Rodio][Rodio]][Rodio-url]

    (back to top)

    @@ -119,7 +103,7 @@ This is an example of how to list things you need to use the software and how to 1. Get a free API Key at [https://example.com](https://example.com) 2. Clone the repo ```sh - git clone https://github.com/github_username/repo_name.git + git clone https://git.colelanders.dev/jlanders/chip8-em.git ``` 3. Install NPM packages ```sh @@ -144,7 +128,7 @@ This is an example of how to list things you need to use the software and how to 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)_ +

    (back to top)

    @@ -153,40 +137,19 @@ _For more examples, please refer to the [Documentation](https://example.com)_ ## Roadmap -- [ ] Feature 1 -- [ ] Feature 2 -- [ ] Feature 3 - - [ ] Nested Feature - -See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues). +- [ ] Super-Chip8 extension +- [ ] XO-CHIP extension +- [ ] More Configuration + - [ ] Window Resizing + - [ ] Allow rebinding keys via GUI + - [ ] Replacing default sound via GUI

    (back to top)

    - - ## Contributing -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. - -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". -Don't forget to give the project a star! Thanks again! - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - -

    (back to top)

    - -### Top contributors: - - - contrib.rocks image - - - +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 @@ -202,7 +165,7 @@ Distributed under the MIT License. See `LICENSE` for more information. Cole Landers - jclanders@pm.me -Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name) +Project Link: [https://git.colelanders.dev/jlanders/chip8-em](https://git.colelanders.dev/jlanders/chip8-em)

    (back to top)

    @@ -211,8 +174,6 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/ ## Acknowledgments -* []() -* []() * []()

    (back to top)

    @@ -222,11 +183,19 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/ +[linkedin-url]: https://linkedin.com/in/linkedin_username--> +[product-screenshot]: images/screenshot.png - - +[Rust]: https://img.shields.io/badge/rust-%23E32F26.svg?style=for-the-badge&logo=rust&logoColor=white +[Rust-url]: https://www.rust-lang.org/ +[Raylib]: https://img.shields.io/badge/raylib-white?style=for-the-badge&logo=target&logoColor=black +[Raylib-url]: https://www.raylib.com/ + +[Clap]: https://img.shields.io/badge/clap-blue?style=for-the-badge&logo=command-line&logoColor=white +[Clap-url]: https://clap.rs/ + +[Rodio]: https://img.shields.io/badge/rodio-orange?style=for-the-badge&logo=audio-bus&logoColor=white +[Rodio-url]: https://github.com/RustAudio/rodio \ No newline at end of file