chore: update readme #64

2026-03-17T01:03:19Z

FramePerfection commented

2026-03-17 01:03:19 +00:00

(Migrated from github.com)

This adjusts the readme to properly reflect the switch to the new build system, includes the label control, and fixes/adjusts the formatting of the headings.

This adjusts the readme to properly reflect the switch to the new build system, includes the `label` control, and fixes/adjusts the formatting of the headings.

FramePerfection (Migrated from github.com) reviewed

2026-03-17 01:12:41 +00:00

FramePerfection (Migrated from github.com) left a comment

I actually had way too much fun going through this "chore", so if there are any more features or things that should be mentioned here (e.g. detailing the provided controls a bit more), I'd be glad to work out some more stuff. 😁
I just didn't want to escalate this too much just yet.

I actually had way too much fun going through this "chore", so if there are any more features or things that should be mentioned here (e.g. detailing the provided controls a bit more), I'd be glad to work out some more stuff. 😁 I just didn't want to escalate this _too much_ just yet.

README.md

					
				@ -2,75 +2,119 @@

				  <img width="128" align="center" src="https://github.com/mupen64/ugui/blob/main/assets/ugui.png?raw=true">

I'm making a bit of a bold assumption here that this is how it's going to work.
What's the actual plan for this?

I'm making a bit of a bold assumption here that this is how it's going to work. What's the actual plan for this?

README.md

At this point, I also wanted to mention how you can run the test suite, but given that the lua runner of my choice is mupen and that that just crashed (not just the script, even mupen), I couldn't write something sensible up 🙃
Is this expected, or did I do something wrong?

At this point, I also wanted to mention how you can run the test suite, but given that the lua runner of my choice is mupen and that that just crashed (not just the script, even mupen), I couldn't write something sensible up 🙃 Is this expected, or did I do something wrong?

README.md

Just as a btw:
I figured that BreitbandGraphics is, in a sense, equally "as top-level" as ugui itself, in the sense that it is feature complete by itself, and just happens to also be hosted in this repository. That's why I adjusted the styling to reflect that a bit more and made it also a h1, which is actually unusual and normally considered bad practice (in html at least...)

Just as a btw: I figured that BreitbandGraphics is, in a sense, equally "as top-level" as ugui itself, in the sense that it is feature complete by itself, and just happens to also be hosted in this repository. That's why I adjusted the styling to reflect that a bit more and made it also a h1, which is actually unusual and normally considered bad practice (in html at least...)

abart27 (Migrated from github.com) reviewed

2026-03-17 05:11:15 +00:00

README.md

					
				@ -2,75 +2,119 @@

				  <img width="128" align="center" src="https://github.com/mupen64/ugui/blob/main/assets/ugui.png?raw=true">

It will work like this, yes. It's fine like this

abart27 (Migrated from github.com) requested changes

2026-03-17 16:17:01 +00:00

README.md

					
				@ -2,75 +2,119 @@

				  <img width="128" align="center" src="https://github.com/mupen64/ugui/blob/main/assets/ugui.png?raw=true">

Download `breitbandgraphics-amalgamated.lua` and `ugui-amalgamated.lua` from the latest [release](https://github.com/mupen64/ugui/releases/latest) and place them anywhere in your project.

Then call `dofile` for them with their absolute paths:

```suggestion Download `breitbandgraphics-amalgamated.lua` and `ugui-amalgamated.lua` from the latest [release](https://github.com/mupen64/ugui/releases/latest) and place them anywhere in your project. Then call `dofile` for them with their absolute paths: ```

README.md

					
				@ -70,1 +76,3 @@

				### Backends

				Build steps:

				1. Open a git bash, then clone the repository and navigate into the repository via the following command:

				```bash