mirror of
https://github.com/imgurbot12/rmenu.git
synced 2025-01-12 23:36:29 +01:00
feat: better plugin/scripting explanations
This commit is contained in:
parent
bffdd56384
commit
553cff8075
1 changed files with 35 additions and 4 deletions
39
README.md
39
README.md
|
@ -25,17 +25,35 @@ $ make install
|
|||
|
||||
### Usage
|
||||
|
||||
RMenu Comes with Two Builtin Plugins: "Desktop Run" aka `drun`.
|
||||
View all available options with the builtin help:
|
||||
|
||||
```bash
|
||||
$ rmenu --help
|
||||
```
|
||||
|
||||
RMenu Comes with a few default plugins.
|
||||
|
||||
| Name | Description |
|
||||
| :-------: | ------------------------------------------------------- |
|
||||
| run | Execute a program in $PATH |
|
||||
| drun | Run a Configured Free-Desktop Application |
|
||||
| audio | Select and Set-Default PulseAudio Sink using `pactl` |
|
||||
| network | Wi-Fi Login/Connection Tool using Network-Manager |
|
||||
| window | Simple Window Switcher (Currently Only Support Sway) |
|
||||
| powermenu | Simple Power/Logout Tool (Currently Only Supports Sway) |
|
||||
|
||||
Run a plugin by passing the `-r` flag like one of the following:
|
||||
|
||||
```bash
|
||||
$ rmenu -r run
|
||||
$ rmenu -r drun
|
||||
$ rmenu -r audio
|
||||
```
|
||||
|
||||
RMenu also comes with a "$PATH Run" plugin aka `run`.
|
||||
Both are managed via the default configuration file after installation.
|
||||
Or even run plugins in combination if you'd like:
|
||||
|
||||
```bash
|
||||
$ rmenu -r drun
|
||||
$ rmenu -r run -r drun
|
||||
```
|
||||
|
||||
Custom Menus can also be passed much like Dmenu by passing items via
|
||||
|
@ -61,6 +79,19 @@ Customize the entire app's appearance with CSS. A few [Example Themes](./themes/
|
|||
are available as reference. To try them out use: `rmenu --css <my-css-theme>`
|
||||
or move the css file to `$HOME/.config/rmenu/style.css`
|
||||
|
||||
### Scripting
|
||||
|
||||
RMenu plugins and imports communicate using JSON messages defined in `rmenu-plugin`.
|
||||
Writing JSON in shell is painful, so rmenu provides another cli-tool to help build
|
||||
messages quickly and easily while still retaining the flexibility of JSON.
|
||||
|
||||
After Installing. Use the following command, and look at [other-plugins](./other-plugins)
|
||||
for example uses.
|
||||
|
||||
```
|
||||
$ rmenu-build --help
|
||||
```
|
||||
|
||||
### Example Screenshots
|
||||
|
||||
#### Launchpad
|
||||
|
|
Loading…
Reference in a new issue