Add description and demo to README
This commit is contained in:
parent
a6f0643e36
commit
82856c64cf
15
README.md
15
README.md
@ -1,2 +1,17 @@
|
|||||||
# gba-fractal-generation
|
# 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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://git.maddiebusig.com/maddiebusig/gba-fractal-generation/raw/branch/trunk/img/fractal_flower.png" alt="Fractal Flower">
|
||||||
|
</div>
|
||||||
Loading…
x
Reference in New Issue
Block a user