diff --git a/README.md b/README.md index 47df529..f50259e 100644 --- a/README.md +++ b/README.md @@ -4,63 +4,17 @@ Master branch badges:![Lint_Test](https://github.com/djotaku/ELDonationTracker/w Would you like to be able to update your donations in real-time during a Live Stream or while recording a Let's Play as in the following screenshots? -![Updates while in-game](https://github.com/djotaku/ELDonationTracker/blob/devel/screenshots/IngameUpdates.png) - -![Updates while the webcam is the main focus](https://github.com/djotaku/ELDonationTracker/blob/devel/screenshots/RecentDonations.png) +![Updates while in-game](https://github.com/djotaku/ELDonationTracker/raw/devel/screenshots/IngameUpdates.png) Read ahead to find out how! -If you find this useful, please consider donating to my Extra Life campagin: http://extralife.ericmesa.com -> I modify this link each year to point to my latest Extra Life campaign. - -# How To use with a GUI - -Watch one of these videos: - -How to use Extra Life Donation Tracker with Linux - -How to use Extra Life Donation Tracker with Wkndows - -or follow the instructions below: - -NOTE: Major Changes occurred in the v3.0 release. Make sure to read the release notes! - -I am now creating executables with each release. Download the executable that goes with your operating system. After you unzip or untar the file: - -On Windows launch gui.exe. - -On Linux launch gui - you may first need to chmod 775 to make it executable. - -Then click on the Settings button to fill in the fields there. If you wish to have your settings persist across version updates, click on Persist Settings. Otherwise, click save and exit the settings window. Open the tracker window and capture that window in OBS or XSplit. In the main GUI hit Run to grab your data for the first time. From there, use the text files it generates in OBS or XSplit. - -# How To use without a GUI - -NOTE: These videos are VERY OUT OF DATE. - -To watch a video of how to use this program on Linux: https://youtu.be/sKaFQPoQeJw - -To watch a video of how to use this program on Windows: https://youtu.be/hN94aPcEFng - -Or follow the instructions below: - -## Setup -First you should edit the values in participant.conf - -Note: - -- The values to the right of the : should be in quotation marks. -- if you're not in a team, the TeamID should be set to 'null' without quotation marks. - -## To run - -On Linux you should type: - -python3 extralifedonations.py +If you find this useful, please consider donating to my [Extra Life campagin](http://extralife.ericmesa.com) -On Windows it's easiest to open extralifedonations.py in IDLE and then run the script from there. (This avoids any issues with python being in your path) +For users, visit: http://djotaku.github.io/ELDonationTracker/ for instructions. # How To for developers -Please see CONTRIBUTING.MD if you wish to contribute. +Please see [CONTRIBUTING.MD](https://github.com/djotaku/ELDonationTracker/blob/master/CONTRIBUTING.md) if you wish to contribute. If you prefer to run from a git clone or from downloading one of the source downloads, follow the instructions below: @@ -78,7 +32,7 @@ to grab the requirements: pip install -r requirements.txt -Finally, decide if you want the GUI or just the commandline. If commandline, only: +Finally, decide if you want to use the GUI or just the commandline. If commandline, only: Fist edit the participant.conf file in a text editor. Then run: @@ -88,7 +42,7 @@ for the GUI type: python3 gui.py -The benefit you get from using the GUI is that cnce the GUI comes up you can click "tracker" to get a window that will display an image and text when a donation is registered +The benefit you get from using the GUI is that once the GUI comes up you can click "tracker" to get a window that will display an image and text when a donation is registered Use the settings window to enter your settings and then hit save to save them.