From 91617b81f6c505a5ef3467839a739e16c42a5ba4 Mon Sep 17 00:00:00 2001 From: Kyan Date: Mon, 30 Sep 2024 21:40:26 +0200 Subject: [PATCH] Write a proper README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 9c58169..f92279a 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ # ELApse + +ELApse is a tool used for processing and displaying the .ELA format from a dead rhythm game + +## Downloading + +You can either download the latest release from the [releases](https://github.com/BlackDragon-B/ELApse/releases) or build it yourself using cargo +## Usage + +```bash +ELApse --input --output + +Options: + -i, --input Input to use + -o, --output Output to use + -h, --help Print help + -V, --version Print version +``` +## Features +### Input +- [WARLS](https://github.com/Aircoookie/WLED/wiki/UDP-Realtime-Control) (--input udp://0.0.0.0:21324) +- Images (--input example.png) +- .uasset/.uexp (--input ELA_BP_Title_in_00.uasset) +- File containing raw rgb8 (--input file) +- Raw rgb8 from stdin (--input stdin) +### Output +- [WARLS](https://github.com/Aircoookie/WLED/wiki/UDP-Realtime-Control) (--output udp://0.0.0.0:21324) +- Built-in renderer built with [Piston](https://www.piston.rs/) (--output piston) +## Contributing + +Feel free to open an issue if you think this tool is missing something critical. Pull requests are always welcome. + +## License + +ELApse is licensed under the [GPLv3](https://choosealicense.com/licenses/gpl-3.0/) license.