docs(README): updated README

This commit is contained in:
2024-05-22 22:30:26 +02:00
parent 5b81f2bef6
commit eb6903e8a3

View File

@@ -2,13 +2,39 @@
A practical application runner written in Rust. Inspired by [dmenu](https://tools.suckless.org/dmenu/) A practical application runner written in Rust. Inspired by [dmenu](https://tools.suckless.org/dmenu/)
### Screenshots
![Screenshot 1](screenshots/screenshot-1716407683.webp) ![Screenshot 1](screenshots/screenshot-1716407683.webp)
![Screenshot 2](screenshots/screenshot-1716407811.webp) ![Screenshot 2](screenshots/screenshot-1716407811.webp)
![Screenshot 3](screenshots/screenshot-1716408039.webp) ![Screenshot 3](screenshots/screenshot-1716408039.webp)
### Features ### Features
- theming (colors, font family, font size, line spacing, window border) - theming (colors, font family, font size, line spacing, window border)
- custom row count - custom row count
- smart row scrolling - smart row scrolling
- prompt message - prompt message
- open menu on a specific display - open menu on a specific display
### Installation
To use practical-runner clone this repository and run the following command in the repository's root directory.
```console
cargo install --path .
```
### Usage
```console
practicalrunner
```
For information about the various arguments run the following command:
```console
practicalrunner --help
```
### Controls
- [enter] to run the selected suggestion
- [up] / [down] arrow to scroll the suggestions
- [escape] / [ctrl-c] to quit