alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-23 08:11:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

Update the description of the folders

Browse source
This commit is contained in:
Gwilym Inzani 2024-04-26 22:17:23 +01:00
parent b886ad55ae
commit e9a7a80baf
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -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 ## 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 `agb-fixnum` - a simple fixed point number storage since the GBA doesn't have a floating point unit, so required
for performant decimals. 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-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-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-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` - the main library code
`agb/examples` - basic examples often targeting 1 feature, you can run these using `just run-example <example-name>` `agb/examples` - basic examples often targeting 1 feature, you can run these using `just run-example <example-name>`
`tracker` - crates that make up the `agb-tracker` library which allows playing of tracker files
`book` - the source for the tutorial and website `book` - the source for the tutorial and website
`book/games` - games made as part of the tutorial `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 `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) `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 ## Stability
While agb is in the pre-1.0 phase, we follow a semi-semantic versioning scheme to ensure compatibility between minor releases. While agb is in the pre-1.0 phase, we follow a semi-semantic versioning scheme to ensure compatibility between minor releases.