Skip to content

Commit

Permalink
doc update for v1.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaae committed Nov 22, 2019
1 parent f047105 commit 54a233b
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 8 deletions.
15 changes: 12 additions & 3 deletions docs/_docs/00-Updating-from-older-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@
name: Updating from older version
anchor: updating-from-older-version
toc:
- name: Update WooferBot
anchor: update-wooferbot
- name: Update WooferBot on windows
anchor: update-wooferbot-on-windows
- name: Update WooferBot on linux
anchor: update-wooferbot-on-linux
---
This section explains how to update WooferBot to newest version.

### Update WooferBot
### 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).
3. Update your configuration as needed to use new features.

### Update WooferBot on linux
1. Download and extract <a class="icon download" href="{{ site.github.url }}/changelog">latest WooferBot release</a> over previous version.
2. Go to wooferbot root directory
3. Install dependencies `python3 -m pipenv install`
4. Start `python3 -m pipenv run python3 wooferbot.py` and close it after startup (This will add all new parameters into your configuration file and update any changes made between versions).
5. Update your configuration as needed to use new features.
20 changes: 17 additions & 3 deletions docs/_docs/01-Installation-and-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
name: Installation and use
anchor: installation-and-use
toc:
- name: Download and prepare files
anchor: download-and-prepare-files
- name: Download and prepare files on windows
anchor: download-and-prepare-files-on-windows
- name: Download and prepare files on linux
anchor: download-and-prepare-files-on-linux
- name: Configure your login information
anchor: configure-your-login-information
- name: Add overlay
Expand All @@ -13,10 +15,22 @@ toc:
---
This section explains installation process, broadcasting software setup and first run.

### Download and prepare files
### 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.

### Download and prepare files on linux
WooferBot is developed using Python 3.8. 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>.
4. Go to wooferbot root directory
5. Install dependencies `python3 -m pipenv install`
6. Start WooferBot using `python3 -m pipenv run python3 wooferbot.py` to create a default configuration file.

<span class="icon idea">Note: Commands based on Ubuntu, may be different on other distributions.</span>
<span class="icon idea">Note: You can create a shell file run wooferbot `python3 -m pipenv run python3 wooferbot.py`.</span>

### Configure your login information
Edit "settings.json" file and change login information for your <a class="icon website" href="https://www.twitch.tv" target="_blank">twitch.tv</a> account. These parameters are **mandatory** for bot to work.
```
Expand Down
3 changes: 1 addition & 2 deletions docs/_docs/90-Developing-wooferbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,4 @@ WooferBot is developed using Python 3.8. It was confirmed to work on Python 3.5.


### Building from source
Windows: Execute `build.cmd`
Linux: Execute `build.sh`
Windows only: Execute `build.cmd`

0 comments on commit 54a233b

Please sign in to comment.