Skip to content

Commit 0fc5bd9

Browse files
authored
Merge pull request #60 from TuffCWC/patch-1
Fix some grammar issues
2 parents f3114ed + 5e231a7 commit 0fc5bd9

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
![Dock with icons after fix](images/sif.png)
44

55
**SIF is a simple Python script allowing you to fix runtime
6-
icons of Steam games displayed in dock or panel to match
7-
Linux system icon theme.**
6+
icons of Steam games displayed in a dock or panel to match
7+
the Linux system icon theme.**
88

99
![Animation](images/animation.svg)
1010

1111
**It aims to be safe, simple and intuitive.**<br>The script must be run by a regular
12-
user and modifies only files in `~/.local/share/applications` directory.
12+
user and modifies only files in the `~/.local/share/applications` directory.
1313

1414
I created this script because I find it very frustrating when the game
1515
icons don't fit the selected icon theme.
@@ -29,12 +29,12 @@ Visit [wiki/Description](https://github.com/BlueManCZ/SIF/wiki/Description).
2929

3030
# Installation
3131

32-
Make sure you have installed Python modules **[PyGObject](https://pypi.org/project/PyGObject/)**, **[requests](https://pypi.org/project/requests/)**
32+
Make sure you have installed the following Python modules: **[PyGObject](https://pypi.org/project/PyGObject/)**, **[requests](https://pypi.org/project/requests/)**
3333
and **[vdf](https://pypi.org/project/vdf/)**. You can use your package manager or pip3 to install them.
3434

35-
Example (after you clone the respository): `pip3 install -r requirements.txt --user`
35+
Example (after you clone the repository): `pip3 install -r requirements.txt --user`
3636

37-
Also make sure you have **[xdotool](https://www.mankier.com/1/xdotool)** installed. It should be available in the official repositories.
37+
Also, make sure you have **[xdotool](https://www.mankier.com/1/xdotool)** installed. It should be available in the official repositories.
3838

3939
After that, all you need to do is **clone** this repository:
4040
```
@@ -46,7 +46,7 @@ Gentoo users may use [ebuild](https://github.com/BlueManCZ/edgets/blob/master/ap
4646

4747
Arch users may use [pkgbuild](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=sif-git) from the [AUR](https://aur.archlinux.org/packages/sif-git/).
4848

49-
Fedora and other RPM-based distro users can use the [COPR Repository](https://copr.fedorainfracloud.org/coprs/chapien/SIF). Install with:
49+
Fedora and other RPM-based distro users can use the [COPR Repository](https://copr.fedorainfracloud.org/coprs/chapien/SIF). Install it with:
5050
```shell
5151
sudo dnf copr enable chapien/SIF
5252
sudo dnf install sif-steam
@@ -70,7 +70,7 @@ or:
7070

7171
### Apply
7272

73-
If commands above worked without a problem, you can **apply** the fix:
73+
If the commands above worked without a problem, you can **apply** the fix:
7474
```
7575
./sif.py
7676
```
@@ -84,50 +84,50 @@ You can also fix only one specific game:
8484
```
8585

8686
### Restore
87-
If you want to **remove** all changes and restore default icons:
87+
If you want to **remove** all changes and restore the default icons:
8888
```
8989
./sif.py --restore
9090
```
9191

9292
# Contribution
9393

94-
For the fix to work, I need to know WM_CLASS of each individual game.
94+
For the fix to work, I need to know the WM_CLASS of each individual game.
9595
I can create fixes only for games which I have installed and I can get
9696
their WM_CLASS.
9797

98-
If you want append your game to our database, you have to know **APP_ID**
99-
and **WM_CLASS** of this game.
98+
If you want to append your game to our database, you have to know the **APP_ID**
99+
and **WM_CLASS** of the game.
100100

101101
#### Get APP_ID
102102

103-
There are multiple ways, how to get APP_ID of Steam game.
103+
There are multiple ways to get an APP_ID of a Steam game.
104104

105105
1. You can use `./sif.py --games` to get APP_IDs of all installed games.
106-
2. From the [steamdb.info](https://steamdb.info/).
107-
3. From the [store.steampowered.com](https://store.steampowered.com/) URL address.
106+
2. From [SteamDB](https://steamdb.info/).
107+
3. From [Steam's](https://store.steampowered.com/) URL address.
108108

109109

110110
#### Get WM_CLASS
111111

112-
Users with xorg can use xprop tool.
112+
Users with xorg can use the xprop tool.
113113

114-
1. Start your game from Steam library.
115-
2. Open new terminal window and run `xprop WM_CLASS`.
116-
3. Switch to the game window with Alt-Tab and left click with mouse on it.
114+
1. Start your game from your Steam library.
115+
2. Open a new terminal window and run `xprop WM_CLASS`.
116+
3. Switch to the game window with Alt-Tab and left click on it with the mouse.
117117
4. Switch back to the terminal and get your WM_CLASS.
118118

119119
#### Missing WM_CLASS?
120120

121-
Some games have their WM_CLASS missing. In this case you can use a WM_NAME of the game. `xprop WM_NAME`
121+
Some games have their WM_CLASS missing. In this case you can get the WM_NAME of the game. `xprop WM_NAME`
122122

123123
#### Proton games are supported natively
124124

125-
Do not contribute Proton games to the database, because they are supported natively.
125+
Do not contribute Proton games to the database because they are supported natively.
126126
WM_CLASS of each Proton game is `steam_app_<APP_ID>`. It is calculated automatically.
127127

128-
#### Create issue or append database
128+
#### Create an issue or append the database
129129

130-
You can open a [new issue](https://github.com/BlueManCZ/SIF/issues), where you provide APP_ID, WM_CLASS (and your icon theme),
130+
You can open a [new issue](https://github.com/BlueManCZ/SIF/issues), where you provide the APP_ID, WM_CLASS (and your icon theme),
131131
and I will add your game to the database as soon as possible.
132132

133133
You can also fork this repository, edit [database.json](https://github.com/BlueManCZ/SIF/blob/master/database.json)

0 commit comments

Comments
 (0)