diff --git a/README.md b/README.md index bf46bbd..94c7473 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,9 @@ -reskit +Reskit ====== -***INCOMPLETE*** +The **R**etro **E**ntertainment **S**oftware Tool**kit** (reskit) is a suite containing a variety of tools useful for creating 8-bit and 16-bit console homebrew software. Reskit allows you to easily generate tilemaps and convert soundtracks for import into your homebrew game projects. -Resource kit for the Sega Genesis/Megadrive. Converts tilesets and soundtracks for use in custom Sega Megadrive game engines. +To get started, check out the [wiki](https://git.ne0ndrag0n.com/ashley/reskit/wiki/?action=_pages) or type `reskit --help` to view a list of supported tools and options. -# Tileset Tool -``` -reskit tileset --input file.png --output file.bin --format bin -``` - -The file format will contain the palette required by the image, followed by the image. - -## Caveats -* Image dimensions that are not a multiple of 8 will be rounded up to the nearest multiple of 8. -* Input images containing more than 15 colours will not be converted and will throw an error. - -# Soundtrack Tool -``` -reskit soundtrack --input song.dmf --output song.bin --format esf -``` - -The file format will contain the instrument definitions, followed by waveform samples, followed by an Echo Stream Format (ESF) stream. +# Build +Reskit is developed in Rust and provided as a cargo crate. Simply type `cargo build` to build the project. Output should be in `target/debug/reskit`.