4
4
[ ![ Latest Version] ( https://img.shields.io/crates/v/run-or-raise.svg )] ( https://crates.io/crates/run-or-raise )
5
5
[ ![ GitHub release] ( https://img.shields.io/github/release/Soft/run-or-raise.svg )] ( https://github.com/Soft/run-or-raise/releases )
6
6
[ ![ dependency status] ( https://deps.rs/repo/github/soft/run-or-raise/status.svg )] ( https://deps.rs/repo/github/soft/run-or-raise )
7
- [ ![ Rust Documentation] ( https://img.shields.io/badge/api-rustdoc-blue.svg )] ( https://docs.rs/crate/run-or-raise )
8
7
[ ![ AUR version] ( https://img.shields.io/aur/version/run-or-raise.svg )] ( https://aur.archlinux.org/packages/run-or-raise/ )
9
8
[ ![ License: GPL v3] ( https://img.shields.io/badge/License-GPL%20v3-blue.svg )] ( https://www.gnu.org/licenses/gpl-3.0 )
10
9
@@ -17,36 +16,32 @@ This can be useful when combined with a tiling window manager such as
17
16
[ i3] ( https://i3wm.org ) or a general purpose keyboard shortcut manager such as
18
17
[ xbindkeys] ( http://www.nongnu.org/xbindkeys/ ) that allow binding arbitrary
19
18
commands to keybindings. In such setup, one might use ` run-or-raise ` to, for
20
- example, launch or focus a web browser with a single key.
19
+ example, launch or focus a web browser with a single key press .
21
20
22
21
` run-or-raise ` is designed to work with X11 based Linux systems.
23
22
24
23
## Installation
25
24
26
- The easiest way to obtain the latest version of ` run-or-raise ` is to download a
27
- precompiled, statically-linked, program binary from [ GitHub releases
28
- page] ( https://github.com/Soft/run-or-raise/releases ) . These binaries should work
29
- on most recent Linux systems without any additional dependencies.
30
-
31
- Alternatively, ` run-or-raise ` can be easily installed from the source using
25
+ ` run-or-raise ` can be installed using
32
26
[ cargo] ( https://doc.rust-lang.org/cargo/index.html ) :
33
27
34
28
``` shell
35
- $ cargo install run-or-raise
29
+ cargo install run-or-raise
36
30
```
37
31
38
32
Compiling and running ` run-or-raise ` requires [ libxcb] ( https://xcb.freedesktop.org )
39
- library to be installed. To get the latest development version of
40
- ` run-or-raise ` , you can direct cargo to install from the git repository:
33
+ library to be installed.
34
+
35
+ To get the latest development version of ` run-or-raise ` , you can direct cargo to
36
+ install from the git repository:
41
37
42
38
``` shell
43
- $ cargo install --git ' https://github.com/Soft/run-or-raise.git'
39
+ cargo install --git ' https://github.com/Soft/run-or-raise.git'
44
40
```
45
41
46
- However, just downloading the application binary or installing with cargo will
47
- not install program’s man page. To also get the manual pages installed, invoke
48
- ` make install ` in the project directory. By default, the install script will
49
- place the files under ` /usr/local/ ` hierarchy.
42
+ Note that cargo will not install man pages. To install ` run-or-raise ` along with
43
+ its manual invoke ` make install ` in the project directory. By default, the
44
+ installation script will place the files under ` /usr/local/ ` hierarchy.
50
45
51
46
## Usage
52
47
@@ -55,7 +50,7 @@ run-or-raise CONDITION PROGRAM [ARGS...]
55
50
```
56
51
57
52
When invoked, ` run-or-raise ` matches existing windows against ` CONDITION ` . If a
58
- matching window is found, it is focused. If none of the windows fulfill the
53
+ matching window is found, it is focused. If none of the windows match the
59
54
criteria, ` run-or-raise ` executes ` PROGRAM ` passing any ` ARGS ` to it as
60
55
arguments.
61
56
0 commit comments