From 362a0e0fe7bfa9d677a6e59c12a2d1b88d9e81e2 Mon Sep 17 00:00:00 2001 From: ashley Date: Sat, 2 Sep 2023 14:46:55 -0400 Subject: [PATCH] License software to the public and update README.md --- LICENSE.md | 17 +++++++++++++++++ README.md | 9 +++++++++ 2 files changed, 26 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..8d0fbfe --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,17 @@ + Copyright (C) 2020-2023 Ashley N. (ne0ndrag0n) + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. diff --git a/README.md b/README.md index 94c7473..0372b86 100644 --- a/README.md +++ b/README.md @@ -5,5 +5,14 @@ The **R**etro **E**ntertainment **S**oftware Tool**kit** (reskit) is a suite con 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. +**Reskit is beta software!** Please read important disclaimers for each tool. + +# Available Tools +* `tileset` - Convert an image to a series of tiles for a given console. + * Supported consoles: Sega Mega Drive VDP (tile and sprite order) +* `soundtrack` - Convert a music sequence to an on-console format/sound driver + * Supported input formats: DMF (Deflemask) Version 27 (1.1.8) + * Supported export formats: Echo Sound Engine (ESF) for Sega Mega Drive + # 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`.