alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2025-01-22 15:16:40 +11:00
Code Issues Projects Releases Packages Wiki Activity

Improve README a little

Browse source
This commit is contained in:
Gwilym Inzani 2023-02-25 22:49:45 +00:00
parent 11822e5c45
commit 6a52e2be14
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -10,17 +10,17 @@
![AGB logo](.github/logo.png) ![AGB logo](.github/logo.png)
This is a library for making games on the Game Boy Advance using the Rust This is a library for making games on the Game Boy Advance using the Rust
programming language. It attempts to be a high level abstraction over the programming language. The library's main focus is to provide an abstraction
internal workings of the Game Boy Advance whilst still being high performance that allows you to develop games which take advantage of the GBA's capabilities
and memory efficient. without needing to have extensive knowledge of its low-level implementation.
agb provides the following features: agb provides the following features:
* Simple build process with minimal dependencies * Simple build process with minimal dependencies
* Built in importing of sprites, backgrounds, music and sound effects * Built in importing of sprites, backgrounds, music and sound effects
* High performance audio mixer * High performance audio mixer
* Simple sprite and tiled background usage * Easy to use sprite and tiled background usage
* Global allocator allowing for use of both `core` and `alloc` * A global allocator allowing for use of both `core` and `alloc`
The documentation for the latest release can be found on The documentation for the latest release can be found on
[docs.rs](https://docs.rs/agb/latest/agb/). [docs.rs](https://docs.rs/agb/latest/agb/).
@ -103,11 +103,10 @@ for performant decimals.
## Stability ## Stability
While in 0.x releases, we are following a semi-semantic versioning. While agb is in the pre-1.0 phase, we follow a semi-semantic versioning scheme to ensure compatibility between minor releases.
So 0.x.y will be compatible with 0.x.z provided that y > z, but any changes Specifically, any 0.x.y release is guaranteed to be compatible with another 0.x.z release provided that y > z, but there may be breaking changes between minor releases (i.e., changes to the second digit, e.g., between 0.1 and 0.2).
to the minor version will be incompatible with one another.
Once we hit version 1.0, we will maintain stronger semantic versioning. Once agb reaches version 1.0, we will transition to stronger semantic versioning, meaning that any breaking changes will be indicated by an increment to the major version (i.e., the first digit, e.g., from 1.0 to 2.0).
## Acknowledgments ## Acknowledgments