doc: Update readme#118
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates and restructures the project README to better present esp-box-emu as a handheld retro console project, with clearer onboarding for playing/building and a more polished feature/emulator overview.
Changes:
- Adds release/license/platform badges and a short “hero” description at the top.
- Rewrites and reorganizes sections (Overview, Emulators table, Gallery, Quick Start, hardware/firmware build steps, SD/ROM setup, roadmap, references, license).
- Adds a concise “Features and Roadmap” checklist and expands documentation around emulator behavior and Doom controls/haptics.
Comment on lines
+53
to
+55
| - 🎮 **Six systems + Doom** — NES, Game Boy / Color, Sega Master System / Game | ||
| Gear, Sega Genesis, and MSX 1/2 emulators, plus a full-speed **Doom** port — | ||
| all with sound. |
|
|
||
| The Box will require one-time programming to function as the emulator box. | ||
| ```sh | ||
| ./esp-box-emu_programmer_v1.0.0_macos.bin |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.