From 6a52e2be14d10f29a81a75266fd4e210c5702b4e Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Sat, 25 Feb 2023 22:49:45 +0000 Subject: [PATCH] Improve README a little --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bc6baf5e..3a6571f8 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,17 @@ ![AGB logo](.github/logo.png) 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 -internal workings of the Game Boy Advance whilst still being high performance -and memory efficient. +programming language. The library's main focus is to provide an abstraction +that allows you to develop games which take advantage of the GBA's capabilities +without needing to have extensive knowledge of its low-level implementation. 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 -* Simple sprite and tiled background usage -* Global allocator allowing for use of both `core` and `alloc` +* Easy to use sprite and tiled background usage +* A global allocator allowing for use of both `core` and `alloc` The documentation for the latest release can be found on [docs.rs](https://docs.rs/agb/latest/agb/). @@ -103,11 +103,10 @@ for performant decimals. ## Stability -While in 0.x releases, we are following a semi-semantic versioning. -So 0.x.y will be compatible with 0.x.z provided that y > z, but any changes -to the minor version will be incompatible with one another. +While agb is in the pre-1.0 phase, we follow a semi-semantic versioning scheme to ensure compatibility between minor releases. +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). -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