Skip to content

Commit fa58c3f

Browse files
authored
Update README.md
1 parent 8da9489 commit fa58c3f

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
1-
Steam-Search *Rofi edition*
1+
# Steam-Search *Rofi edition*
22

3-
![Screenshot 1](/screenshots/screenshot3.png)
4-
![Screenshot 2](/screenshots/screenshot2.png)
3+
![Steam Search using icon type](/screenshots/screenshot3.png)
4+
5+
## Installation
6+
7+
### Manual Install
8+
9+
1. Download the executable from here: [Releases](https://github.com/Garulf/Steam-Search-rofi/releases)
10+
2. Move `steam-search.pyz` to your Rofi scripts directory (~/.config/rofi/scripts)
11+
3. Run `chmod +x ./steam-search.pyz` to allow Steam Search to run.
12+
13+
## Usage
14+
15+
Steam Search can be launched easily with:
16+
```
17+
rofi -modes steam-search -show steam-search
18+
```
19+
20+
## Options
21+
22+
Steam Search allows you to customize some of its features using environmental variables.
23+
24+
| ENV | DEFAULT | INPUT | Description |
25+
|------------|----------------------|-------------------------|-----------------------------------------------------------------|
26+
| STEAM_PATH | ~/.local/share/steam | Steam install directory | This is the path Steam Search uses to find your Steam library. |
27+
| ICON_TYPE | icon | icon, grid | Set what type of image Steam Search will use for icons in Rofi. |
28+
29+
example:
30+
```
31+
ICON_TYPE=grid rofi -modes steam-search -show steam-search
32+
```
33+
34+
## More screenshots
35+
36+
![Steam Search using grid icon type](/screenshots/screenshot2.png)

0 commit comments

Comments
 (0)