Skip to content

Commit d768a72

Browse files
committed
readme: update
1 parent fe4abb3 commit d768a72

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ https://github.com/user-attachments/assets/2d3da6ea-2e80-42c3-bbd6-5a2c59601201
1717
- [esp-box-emu](#esp-box-emu)
1818
- [Overview](#overview)
1919
- [Images and Videos](#images-and-videos)
20+
- [Quick Start](#quick-start)
21+
- [Program It](#program-it)
2022
- [Parts](#parts)
2123
- [Features](#features)
2224
- [Cloning](#cloning)
@@ -85,6 +87,25 @@ https://github.com/esp-cpp/esp-box-emu/assets/213467/3b77f6bd-4c42-417a-9eb7-a64
8587

8688
https://github.com/esp-cpp/esp-box-emu/assets/213467/a3d18d03-c6a1-4911-89d1-e18119e8cc03
8789

90+
## Quick Start
91+
92+
If you already have the hardware or an ESP32-S3-BOX and just want to program
93+
this code onto it, this section is for you!
94+
95+
### Program It
96+
97+
The Box will require one-time programming to function as the emulator box.
98+
99+
Download the release `programmer` executable from the latest [releases
100+
page](https://github.com/esp-cpp/esp-box-emu/releases) for `windows`,
101+
`macos`, or `linux` - depending on which computer you want to use to perform the
102+
one-time programming.
103+
104+
1. Download the programmer
105+
2. Unzip it
106+
3. Double click the `exe` (if windows), or open a terminal and execute it from
107+
the command line `./esp-box-emu_programmer_v0.13.0_macos.bin`.
108+
88109
## Parts
89110

90111
This project is designed to be in the same form factor as the Gameboy Color and

0 commit comments

Comments
 (0)