From 4c52d183fa4392e4b35ce58e1782fa06eb163f2a Mon Sep 17 00:00:00 2001 From: Anghelo Carvajal Date: Wed, 21 Sep 2022 06:04:36 -0300 Subject: [PATCH] Add basic stuff to the readme (#31) * basic readme * testing table * add ido to table * Center columns * Add build dependencies * mark non _rom ones with X * Update README.md Co-authored-by: Derek Hensley Co-authored-by: Derek Hensley --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f248cbe..8e33dc0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,43 @@ -# Building -* `make -C tools` -* `make setup` -* `make` +# ultralib + +Reverse engineering of libultra + +## Compatibility + +Currently this repo supports building the following versions: + +| IDO / GCC | `libultra.a` / `libgultra.a` | `libultra_d.a` / `libgultra_d.a` | `libultra_rom.a` / `libgultra_rom.a` | +| - | :-: | :-: | :-: | +| 2.0E | :x: / N/A | :x: / N/A | :x: / N/A | +| 2.0F | :x: / N/A | :x: / N/A | :x: / N/A | +| 2.0G | :x: / N/A | :x: / N/A | :x: / N/A | +| 2.0H | :x: / :x: | :x: / :x: | :x: / :x: | +| 2.0I | :x: / :x: | :x: / :x: | :x: / :x: | +| 2.0I_patch | :x: / :x: | :x: / :x: | :x: / :x: | +| 2.0J | :x: / :x: | :x: / :x: | :x: / :x: | +| 2.0K | :x: / :x: | :x: / :x: | :x: / :x: | +| 2.0L | :x: / :x: | :x: / :x: | :x: / :heavy_check_mark: | +| ique_v1.5 | :x: | :x: | :x: | + +## Preparation + +After cloning the repo, put a copy of the target archive on the root of this directory. + +## Build dependencies + +The build process requires the following packages: + +- build-essential +- python3 + +Under Debian / Ubunutu you can install them with the following commands: + +```bash +sudo apt update +sudo apt install build-essential python3 +``` + +## Building + +- `make setup` +- `make`