Skip to content

Commit

Permalink
doc update for 1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaae committed Feb 18, 2022
1 parent 4dae4e4 commit ac8ab97
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/_docs/00-Updating-from-older-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section explains how to update WooferBot to newest version.

### Update WooferBot on windows
1. Download and extract <a class="icon download" href="{{ site.github.url }}/changelog">latest WooferBot release</a> over previous version.
2. Start <span class="icon file">wooferbot_cli.exe</span> and close it after startup (This will add all new parameters into your configuration file and update any changes made between versions).
2. Start <span class="icon file">wooferbot.exe</span> and close it after startup (This will add all new parameters into your configuration file and update any changes made between versions).
3. Update your configuration as needed to use new features.

### Update WooferBot on linux
Expand Down
6 changes: 3 additions & 3 deletions docs/_docs/01-Installation-and-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ This section explains installation process, broadcasting software setup and firs

### Download and prepare files on windows
1. Download and extract <a class="icon download" href="{{ site.github.url }}/changelog">latest WooferBot release</a>.
2. Start WooferBot using <span class="icon file">wooferbot_cli.exe</span> to create a default configuration file.
2. Start WooferBot using <span class="icon file">wooferbot.exe</span> to create a default configuration file.

### Download and prepare files on linux
WooferBot is developed using Python 3.8. It was confirmed to work on Python 3.5.
WooferBot is developed using Python 3.9. It was confirmed to work on Python 3.5.
1. Install `python3, python3-pip`
2. Install pipenv `python3 -m pip install pipenv`
3. Download and extract <a class="icon download" href="{{ site.github.url }}/changelog">latest WooferBot release</a>.
Expand Down Expand Up @@ -57,6 +57,6 @@ Add <span class="icon file">overlay.html</span> as <a class="icon website" href=
<span class="icon idea">Note: This approach will prevent using multiple browser sources, which would require more system resources and cause possible conflicts or missed notifications.</span>

### Starting WooferBot
To start WooferBot execute <span class="icon file">wooferbot_cli.exe</span>.
To start WooferBot execute <span class="icon file">wooferbot.exe</span>.

To customize WooferBot, adjust "settings.json" as needed (see <a class="icon doc" href="{{ site.github.url }}/documentation#basic-configuration">Basic configuration</a> section).

0 comments on commit ac8ab97

Please sign in to comment.