From e9a7a80baf4e825e3886a4ec2c20b84f91c2942f Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Fri, 26 Apr 2024 22:17:23 +0100 Subject: [PATCH 1/5] Update the description of the folders --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f4bef21e..55287071 100644 --- a/README.md +++ b/README.md @@ -72,33 +72,43 @@ Note that before you create a PR, please file an issue so we can discuss what yo ## Structure of the repo +`agb-debug` - a tool you can use to decode agb stacktraces + `agb-fixnum` - a simple fixed point number storage since the GBA doesn't have a floating point unit, so required for performant decimals. +`agb-gbafix` - a clean-room reimplementation of the gbafix utility that accepts elf files rather than binaries + +`agb-hashmap` - an no_std hashmap implementation tuned for use on the game boy advance + `agb-image-converter` - a crate which converts images in normal formats to a format supported by the game boy advance `agb-macros` - miscellaneous proc-macros which have to be in a different crate `agb-sound-converter` - a crate which converts wav files into a format supported by the game boy advance -`agb-hashmap` - an no_std hashmap implementation tuned for use on the game boy advance - `agb` - the main library code `agb/examples` - basic examples often targeting 1 feature, you can run these using `just run-example ` -`tracker` - crates that make up the `agb-tracker` library which allows playing of tracker files - `book` - the source for the tutorial and website `book/games` - games made as part of the tutorial +`emulator` - Rust bindings for the [mgba](https://mgba.io) emulator used for our purposes + +`emulator/test-runner` - The source for the test runner used to run unit tests within the emulator + `examples` - bigger examples of a complete game, made during game jams -`emulator` - Rust bindings for the [mgba](https://mgba.io) emulator used for our purposes. Currently this does not accept contributions. - `template` - the source for the [template repository](https://github.com/agbrs/template) +`tools` - misc. tools used in the development of `agb` itself + +`tracker` - crates that make up the `agb-tracker` library which allows playing of tracker files + +`website` - the source of [the website](https://agbrs.dev) + ## Stability While agb is in the pre-1.0 phase, we follow a semi-semantic versioning scheme to ensure compatibility between minor releases. From 13ef5d4ce22ce3c783a32f45595c40e996f13f9a Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Fri, 26 Apr 2024 22:24:23 +0100 Subject: [PATCH 2/5] Include the tracker in the headline features --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55287071..a9d56135 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ agb provides the following features: - Simple build process with minimal dependencies - Built in importing of sprites, backgrounds, music and sound effects -- High performance audio mixer +- High performance audio mixer and optional tracker which can play `.xm` files - Easy to use sprite and tiled background usage - A global allocator allowing for use of both `core` and `alloc` From 86f8cc45d41582737ca3acc0845ed2580e8df5dc Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Fri, 26 Apr 2024 22:25:04 +0100 Subject: [PATCH 3/5] Update the website link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a9d56135..84053601 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The best way to get started with agb is to use the template, either within the Once you have done this, you will find further instructions within the README in the template. -There is an (in progress) tutorial which you can find on the [project website](https://agbrs.github.io/agb/). +There is an (in progress) tutorial which you can find on the [project website](https://agbrs.dev/). ## Help / Support From c97de67fa68d32961aa9c60bd203fd1dce1b4b03 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Fri, 26 Apr 2024 22:25:39 +0100 Subject: [PATCH 4/5] Correct command to update rustup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84053601..ebf3aec0 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ to just write games for the Game Boy Advance using this library: - Recent rustup, see [the rust website](https://www.rust-lang.org/tools/install) for instructions for your operating system. - - You can update rustup with `rustup update`, or using your package manager + - You can update rustup with `rustup self update`, or using your package manager if you obtained rustup in this way. - libelf and cmake - Debian and derivatives: `sudo apt install libelf-dev cmake` From ceab4302d4ebd7c929d2014f2b51733d2e570ff0 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Fri, 26 Apr 2024 22:27:38 +0100 Subject: [PATCH 5/5] Can just refer to the emulator directly once --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index ebf3aec0..4e679972 100644 --- a/README.md +++ b/README.md @@ -95,9 +95,7 @@ for performant decimals. `book/games` - games made as part of the tutorial -`emulator` - Rust bindings for the [mgba](https://mgba.io) emulator used for our purposes - -`emulator/test-runner` - The source for the test runner used to run unit tests within the emulator +`emulator` - Rust bindings for the [mgba](https://mgba.io) emulator along with the test runner you can use to run unit tests `examples` - bigger examples of a complete game, made during game jams