Update readme
This commit is contained in:
17
README.md
17
README.md
@@ -1,3 +1,20 @@
|
|||||||
# rate music
|
# rate music
|
||||||
This is a simple tool to rate music on your device by people.
|
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.
|
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.
|
||||||
|
Reference in New Issue
Block a user