readme: changed the formatting a bit
This commit is contained in:
parent
1dd3da8b28
commit
6d76f8d674
1 changed files with 7 additions and 0 deletions
|
@ -11,7 +11,9 @@ Just run this.
|
||||||
make all
|
make all
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
## Help message
|
## Help message
|
||||||
```
|
```
|
||||||
usage: RapidMenu [flags] [<command> [args]]
|
usage: RapidMenu [flags] [<command> [args]]
|
||||||
|
@ -19,12 +21,14 @@ LISTING COMMANDS:
|
||||||
-c: To specify which config to use.
|
-c: To specify which config to use.
|
||||||
-b: Make a executable out of a config.
|
-b: Make a executable out of a config.
|
||||||
```
|
```
|
||||||
|
|
||||||
### You will need to first setup the config dir
|
### You will need to first setup the config dir
|
||||||
To do that you just need to, use this command.
|
To do that you just need to, use this command.
|
||||||
```
|
```
|
||||||
RapidMenu
|
RapidMenu
|
||||||
```
|
```
|
||||||
And it should say "Created /home/$USER/.config/RapidMenu".
|
And it should say "Created /home/$USER/.config/RapidMenu".
|
||||||
|
|
||||||
### How to use (-c)
|
### How to use (-c)
|
||||||
If you want to open a configuration, just use this command.
|
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
|
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.
|
to make a dashboard, then call it dashboard.conf. For games, use games.conf etc.
|
||||||
|
|
||||||
### How to use (-b)
|
### How to use (-b)
|
||||||
Just use this command, it will throw an error if incorrect.
|
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.
|
Also, it will ask what you want to name the executable, and if it already exists.
|
||||||
```
|
```
|
||||||
RapidMenu -b [config]
|
RapidMenu -b [config]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
It is required to have the [runner] section in the configuration.
|
It is required to have the [runner] section in the configuration.
|
||||||
Example:
|
Example:
|
||||||
|
@ -54,5 +60,6 @@ names = "Disk" (To set the in the runner)
|
||||||
description = "You chose Disk." (No required but can be set)
|
description = "You chose Disk." (No required but can be set)
|
||||||
command = "kitty -e /home/$USER/.config/RapidMenu/hdd.bash" (bash command)
|
command = "kitty -e /home/$USER/.config/RapidMenu/hdd.bash" (bash command)
|
||||||
```
|
```
|
||||||
|
|
||||||
# Contributors
|
# Contributors
|
||||||
- DRAGONTOS
|
- DRAGONTOS
|
||||||
|
|
Loading…
Add table
Reference in a new issue