mirror of
https://github.com/davatorium/rofi.git
synced 2024-11-18 13:54:36 -05:00
Restructure README.md
This commit is contained in:
parent
c905f3ab60
commit
faf46b2473
1 changed files with 57 additions and 66 deletions
37
README.md
37
README.md
|
@ -1,4 +1,4 @@
|
|||
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ca0310962a7c4b829d0c57f1ab023531)](https://app.codacy.com/app/davatorium/rofi?utm_source=github.com&utm_medium=referral&utm_content=davatorium/rofi&utm_campaign=Badge_Grade_Settings)
|
||||
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ca0310962a7c4b829d0c57f1ab023531)](https://app.codacy.com/app/davatorium/rofi?utm_source=github.com\&utm_medium=referral\&utm_content=davatorium/rofi\&utm_campaign=Badge_Grade_Settings)
|
||||
[![Build Status](https://travis-ci.org/davatorium/rofi.svg?branch=master)](https://travis-ci.org/davatorium/rofi)
|
||||
[![codecov.io](https://codecov.io/github/davatorium/rofi/coverage.svg?branch=master)](https://codecov.io/github/davatorium/rofi?branch=master)
|
||||
[![Issues](https://img.shields.io/github/issues/davatorium/rofi.svg)](https://github.com/davatorium/rofi/issues)
|
||||
|
@ -24,25 +24,25 @@ Its main features are:
|
|||
|
||||
* Fully configurable keyboard navigation
|
||||
* Type to filter
|
||||
- Tokenized: type any word in any order to filter
|
||||
- Case insensitive (togglable)
|
||||
- Support for fuzzy-, regex-, and glob matching
|
||||
* Tokenized: type any word in any order to filter
|
||||
* Case insensitive (togglable)
|
||||
* Support for fuzzy-, regex-, and glob matching
|
||||
* UTF-8 enabled
|
||||
- UTF-8-aware string collating
|
||||
- International keyboard support (`e -> è)
|
||||
* UTF-8-aware string collating
|
||||
* International keyboard support (\`e -> è)
|
||||
* RTL language support
|
||||
* Cairo drawing and Pango font rendering
|
||||
* Built-in modes:
|
||||
- Window switcher mode
|
||||
- EWMH compatible WM
|
||||
- Application launcher
|
||||
- Desktop file application launcher
|
||||
- SSH launcher mode
|
||||
- Combi mode, allowing several modes to be merged into one list
|
||||
* Window switcher mode
|
||||
* EWMH compatible WM
|
||||
* Application launcher
|
||||
* Desktop file application launcher
|
||||
* SSH launcher mode
|
||||
* Combi mode, allowing several modes to be merged into one list
|
||||
* History-based ordering — last 25 choices are ordered on top based on use (optional)
|
||||
* Levenshtein distance ordering of matches (optional)
|
||||
* Drop-in dmenu replacement
|
||||
- Many added improvements
|
||||
* Many added improvements
|
||||
* Easily extensible using scripts
|
||||
* Theming
|
||||
|
||||
|
@ -66,7 +66,6 @@ Window mode features:
|
|||
* Closing applications with `Shift-Delete`
|
||||
* Custom command with `Shift-Return`
|
||||
|
||||
|
||||
## Application launcher
|
||||
|
||||
![run mode](https://davatorium.github.io/rofi/images/rofi/run-dialog.png)
|
||||
|
@ -79,7 +78,6 @@ Run mode features:
|
|||
* Favorites list, with frequently used programs sorted on top
|
||||
* Custom entries, like aliases, added by executing a command
|
||||
|
||||
|
||||
## Desktop File Application launcher
|
||||
|
||||
The desktop run mode allows users to quickly search and launch an application from the *freedesktop.org* Desktop
|
||||
|
@ -99,9 +97,7 @@ Quickly `ssh` into remote machines. Parses `~/.ssh/config` and `~/.ssh/known_hos
|
|||
|
||||
Loads external scripts to add modes to **Rofi**, for example a file-browser.
|
||||
|
||||
```
|
||||
rofi -show fb -modi fb:../Examples/rofi-file-browser.sh
|
||||
```
|
||||
|
||||
## COMBI mode
|
||||
|
||||
|
@ -110,9 +106,7 @@ Allowing to quickly switch to an application, either by switching to it when it
|
|||
|
||||
Example to combine Desktop run and the window switcher:
|
||||
|
||||
```
|
||||
rofi -combi-modi window,drun -show combi -modi combi
|
||||
```
|
||||
|
||||
## dmenu replacement
|
||||
|
||||
|
@ -129,7 +123,7 @@ write them to stdout.
|
|||
|
||||
# Usage
|
||||
|
||||
If used with `-show [mode]`, rofi will immediately open in the specified [mode].
|
||||
If used with `-show [mode]`, rofi will immediately open in the specified \[mode].
|
||||
|
||||
If used with `-dmenu`, rofi will use data from STDIN to let the user select an option.
|
||||
|
||||
|
@ -146,10 +140,8 @@ To show a ssh dialog:
|
|||
If rofi is passed the `-dmenu` option, or run as `dmenu` (ie, /usr/bin/dmenu is symlinked to /usr/bin/rofi),
|
||||
it will use the data passed from STDIN.
|
||||
|
||||
```
|
||||
~/scripts/my_script.sh | rofi -dmenu
|
||||
echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu
|
||||
```
|
||||
|
||||
In both cases, rofi will output the user's selection to STDOUT.
|
||||
|
||||
|
@ -157,7 +149,6 @@ In both cases, rofi will output the user's selection to STDOUT.
|
|||
|
||||
Type `Shift-/Left/Right` to switch between active modi.
|
||||
|
||||
|
||||
## Key bindings
|
||||
|
||||
| Key | Action |
|
||||
|
|
Loading…
Reference in a new issue