Skip to content

Commit e7199cb

Browse files
committed
Fix typos and improve clarity in documentation
1 parent 342ab1e commit e7199cb

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

Readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ There is also an [AUR package](https://aur.archlinux.org/packages/steam-boilr-gu
5656

5757
## Integrations
5858

59-
BoilR can import games from many platforms, but there are limits based
59+
BoilR can import games from many platforms, but there are limitations
6060

6161
| Platforms | Windows | Linux (executable) | Linux (flatpak) |
6262
| ------------------------------------------------------------------------------- | ------- | ----------------------------- | ----------------------------------------- |
@@ -117,7 +117,7 @@ If you experience bugs or errors please try the native version and see if that f
117117
### How can I help/contribute?
118118
If you are a coder, you are very welcome! You can fork this repo and then create a pull request.
119119

120-
To check formats and errors of code before run the code:
120+
To check formats and errors of code before running the code:
121121

122122
```shell
123123
cargo fmt
@@ -148,4 +148,4 @@ Nope, please don't, donate it to your favorite charity instead, and if you don't
148148
This project is dual license MIT or Apache 2.0 , it is up to you. In short, you can do what you want with this project, but if in doubt read the license files.
149149

150150
## What is up with the name BoilR?
151-
This tool turns things into Steam, therefor boiler, And it is written in **R**ust so therefor: BoilR
151+
This tool turns things into Steam, therefore boiler, And it is written in **R**ust, so therefore: BoilR

configuration.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Configuration
22

33
The tool reads its configuration from a `config.toml` file. If it cannot find one, it will create a default one on its first run.
4-
You can either manually edit this file or use the UI version to changing the configurations.
5-
Most people will not need to change the configuration and BoilR can find different launchers without problem.
4+
You can either manually edit this file or use the UI version to change the configurations.
5+
Most people will not need to change the configuration and BoilR can find different launchers without problems.
66

77
Here is a simple example of how to write the config file:
88

@@ -16,7 +16,7 @@ And here is a full example of all configuration options:
1616
```toml
1717

1818
[epic_games]
19-
enabled=true #On windows this is default true, on linux default false
19+
enabled=true #On Windows this is default true, on Linux default false
2020
location="C:\\ProgramData\\Epic\\EpicGamesLauncher\\Data\\Manifests" #If this value is not defined, the tool will try to find it automatically (only windows). If it can't find it, it will fail and tell you.
2121
create_symlinks = true #Only for Linux, To get around a bug in steam where paths can not contain spaces, BoilR creates symlinks in ~/.boilr/link and uses those.
2222

@@ -35,7 +35,7 @@ create_symlinks = true #Only for Linux, To get around a bug in steam where paths
3535

3636
[origin]
3737
enabled=true
38-
location="C:\\ProgramData\\Origin" #If this value is not defined, "%PROGRAMGDATA%origin" will be used on windows, and HOME/Games/origin/drive_c/ProgramData/Origin/ on linux.
38+
location="C:\\ProgramData\\Origin" #If this value is not defined, "%PROGRAMDATA%\\Origin" will be used on Windows, and HOME/Games/origin/drive_c/ProgramData/Origin/ on Linux.
3939

4040
[gog]
4141
enabled=true
@@ -45,8 +45,8 @@ wine_c_drive="/home/username/Games/gog-galaxy/drive_c" #Only for Linux, Is manda
4545

4646
[steam]
4747
location="C:\\Program Files (x86)\\Steam\\" #If this value is not defined, the tool will try to find it automatically. If it can't find it, it will fail and tell you.
48-
optimize_for_big_picture=false #Set icons to wide images, that big picture mode will use. This will make the icons have a wrong ratio in desktop mode, but will improve the look in big picture mode
49-
create_collections=false #Will try to create a steam collection for each platform
48+
optimize_for_big_picture=false #Set icons to wide images that Big Picture mode will use. This will make the icons have a wrong ratio in desktop mode but will improve the look in Big Picture mode
49+
create_collections=false #Will try to create a Steam collection for each platform
5050

5151
[steamgrid_db]
5252
enabled = true #If false, the whole download of custom art will be skipped.
@@ -55,7 +55,7 @@ prefer_animated = false #If true, animated images will be prefered over static i
5555
```
5656

5757

58-
## No Vsync
59-
BoilR runs with Vsync Enabled, to limit its resource use.
60-
This can be a problem for some setups that run Linux, Wayland and Nvidia (but not all).
61-
If BoilR just crashes when you start it, try to add `--no-vsync` as an argument when you launch boilr.
58+
## No VSync
59+
BoilR runs with VSync enabled to limit its resource use.
60+
This can be a problem for some setups that run Linux, Wayland, and Nvidia (but not all).
61+
If BoilR just crashes when you start it, try to add `--no-vsync` as an argument when you launch BoilR.

0 commit comments

Comments
 (0)