diff --git a/README.md b/README.md index 21215a4..cbf1feb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ Just run this. make all sudo make install ``` + # Usage + ## Help message ``` usage: RapidMenu [flags] [ [args]] @@ -19,12 +21,14 @@ LISTING COMMANDS: -c: To specify which config to use. -b: Make a executable out of a config. ``` + ### You will need to first setup the config dir To do that you just need to, use this command. ``` RapidMenu ``` And it should say "Created /home/$USER/.config/RapidMenu". + ### How to use (-c) If you want to open a configuration, just use this command. ``` @@ -32,12 +36,14 @@ RapidMenu -c [config] ``` You should put the config files in the config dir. So, if you want to make a dashboard, then call it dashboard.conf. For games, use games.conf etc. + ### How to use (-b) Just use this command, it will throw an error if incorrect. Also, it will ask what you want to name the executable, and if it already exists. ``` RapidMenu -b [config] ``` + ## Configuration It is required to have the [runner] section in the configuration. Example: @@ -54,5 +60,6 @@ names = "Disk" (To set the in the runner) description = "You chose Disk." (No required but can be set) command = "kitty -e /home/$USER/.config/RapidMenu/hdd.bash" (bash command) ``` + # Contributors - DRAGONTOS