6 Commits

Author SHA1 Message Date
Alex Duchesne
3dbe19b186 Formatting 2025-06-25 04:04:12 -04:00
Alex Duchesne
29cbbcb57d Update PORTING.md to add very basic code patching insructions 2024-12-13 15:51:27 -05:00
Alex Duchesne
8ac2f3d4a2 Updated PORTING.md 2024-12-13 15:40:39 -05:00
Alex Duchesne
8365c015ff Updated PORTING.md 2024-12-13 15:39:26 -05:00
Alex Duchesne
b125acc742 Added IDE section to BUILDING.md 2024-10-30 00:16:59 -04:00
Rohan Gupta
45bdfaf6f8
Instructions for porting retro-go to custom hardware (#156)
* PATCHING.md and some instructions for building imgs

* Add Custom Hardware to the table of contents

* Github Markdown formatting changes

* Update BUILDING.md

I'm not too keen on your changes in BUILDING.md. Once a .img/.fw has been flashed, flash/run/monitor will work regardless of the initial format but your addition implies that those don't apply to .img but they do.

I think what should be done instead is move your new "Flashing" section to be right after the "Build everything" section. Maybe rename it "Initial Flashing" or "First Installation" or something along those lines. Then describe how to flash a .img or a .fw for the first time on a new device.


I'm doing a commit just to quickly show you what I have in mind, feel free to revert or entirely rewrite and continue with your vision :)

* Remove redundant changes in README.md
While previous changes in the README.md introduced unnececary info, I do want to keep some links.

One thing is that a link to building/installing should definetly be higher up, as I wasn't sure where to get started with retro-go until I scrolled down the whole README

Another thing is that I added a link to PATCHING in the "Generic ESP32" install instructions as their was already a mention about porting in it

* Rename PATCHING and replace all occurances/refs

Yup, this name makes much more sense

* Fill in blank info and reorganize rg_tool info

This fills in instructions for the esp_tool info.
Also, it made more sense to describe rg_tool in BUILDING.md as it isn't only used for porting

* Consitency with Links and commands

This adds links (to the relevent section) to unlinked text. Also makes the difference between `./rg_tool.py` and `python rg_tool.py` a little more consistant

* Remove Unused Title in README

* Remove redundant spaces and lines

---------

Co-authored-by: ducalex <ducalex007@gmail.com>
2024-10-11 13:53:05 -04:00