From 82856c64cff06dc3f8042078567598d80ae587c9 Mon Sep 17 00:00:00 2001 From: Madeline Busig Date: Wed, 7 May 2025 10:07:13 +0000 Subject: [PATCH] Add description and demo to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index aac3b15..39245d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # gba-fractal-generation +This is a basic [L-system](https://en.wikipedia.org/wiki/L-system) (ish) fractal generator for the Nintendo GameBoy Advance (GBA). Because the GBA is such an underpowered console, it doesn't support everything a complex fractal generator could do. But! It still lets you generate some neat graphics. + +### Compilation + +Because this project is built for the GBA, it relies on the [DevKitPro](https://devkitpro.org/) GBA toolchain. It also requires the [ETL (Embedded Template Library)](https://etlcpp.com/), and [MTL (My Template Library)](https://git.maddiebusig.com/maddiebusig/mtl) for some containers and vector goodies. Both these libraries are included as Git submodules, and will be compiled once you set up the CMake project (if you want). Because of the time sink that setting this project up is, some finished demo builds can be found inside the `demos` directory. + +### Running + +Because this program is buit for the GameBoy Advance, you will need an emulator in order to run it. I used [mGBA](https://mgba.io/) during the development, and it is untested on other emulators or physical hardware. The logging system in MTL also supports outputting to mGBA's debug console, if you would like to see some text output. + +--- + +
+Fractal Flower +
\ No newline at end of file