From afb1729498a16155d475df490a96be9ce677cbda Mon Sep 17 00:00:00 2001 From: structix Date: Mon, 25 Mar 2024 16:18:04 +0100 Subject: [PATCH] Update readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6c45b40..992e529 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # rate music This is a simple tool to rate music on your device by people. It can be used at parties to rate your playlist for further analysis. + +## Compile +Use `cargo build -r` to build a release executable. + +## Usage +At first run you will be prompted to add a new user. +This can be achieved as follows: +```sh +# Add a new user +./rate_music [username] + +# Add a new user with a specific ID +./rate_music [username] [ID] +``` + +### Exit the program +To avoid exiting the program by mistake you have to press `ctrl + m` to leave the prompt.