Skip to content

Commit 5ca732f

Browse files
committed
Updates to documentation.
1 parent c02d6eb commit 5ca732f

4 files changed

Lines changed: 161 additions & 206 deletions

File tree

docs/CLIHELP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Sets a non-default location for the storing and loading of cached game resources
5656

5757
!!! note
5858

59-
If you wish to _always_ use a certain location as base folder for your resource cache ((for instance if you want your cache to reside on a USB drive), it is _strongly_ recommended to set this in the `config.ini` file instead. Read more about the relevant [`config.ini` option](CONFIGINI.md#cachefolder).
59+
If you wish to _always_ use a certain location as base folder for your resource cache (for instance if you want your cache to reside on a USB drive), it is _strongly_ recommended to set this in the `config.ini` file instead. Read more about the relevant [`config.ini` option](CONFIGINI.md#cachefolder).
6060

6161
**Example(s)**
6262

docs/CONFIGINI.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,16 @@ Settings in the `[main]` section will always be set regardless of selected platf
2020

2121
### Order of Precedence
2222

23-
Each section can have overlapping parameters. In case where a certain option exists in several sections they are prioritized as scraping module first, then frontend, then platform and lastly main. Any commandline (CLI) option which relates to an configuration setting in `config.ini` has highest precedence, regardless of the other four levels respective sections.
23+
Each section can have overlapping parameters. In case where a certain option exists in several sections they are prioritized as scraping module first, then frontend, then platform and lastly main. Any commandline interface (CLI) option which relates to an configuration setting in `config.ini` has highest precedence, aces out each scraping module section and other lower prioritized sections (frontend, platform and main). If a configuration option is neither set via CLI nor via configuration file, its default value is applied. In summary:
2424

25-
You can find an example config file at `/home/<USER>/.skyscraper/config.ini.example`. This file contains all available options. Just copy the file to `config.ini` and uncomment and edit the ones you wish to use by removing the `#` or `;` in front of the variables. Remember to also uncomment the section the option relates to such as `[main]` or `[amiga]`.
25+
1. CLI
26+
↳ 2. `[<scraper>]`
27+
&nbsp;&nbsp; ↳ 3. `[<frontend>]`
28+
&nbsp;&nbsp;&nbsp;&nbsp; ↳ 4. `[<platform>]`
29+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ↳ 5. `[main]`
30+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ↳ 6. built-in default
31+
32+
You can find an example config file at `/home/<USER>/.skyscraper/config.ini.example`. This file contains all available options. Just copy the file to `config.ini` and uncomment and edit the ones you wish to use by removing the `#` or `;` in front of the variables. Remember to also uncomment the `[<section>]` line which the option relates to such as `[main]` or `[amiga]`.
2633

2734
!!! note
2835

0 commit comments

Comments
 (0)