diff --git a/README.md b/README.md index e975494..e973144 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# Chatterino-Restarter-Script +# Chatterino Restarter Script -A simple python script to check if Chatterino is running and if not then start it. Made because Chatterino always crashes while I am away and that's annoying. \ No newline at end of file +A simple python script to check if Chatterino is running and start it if its not. I made this because Chatterino always crashes while I am away and that's really annoying. + +## How it works + +1. The script sits in the background *(in a terminal window for now, just minimize it or something)*. +2. It checks if Chatterino is running or not. +3. If Chatterino is not running, start it through the configured path. +4. If Chatterino is currently running, do nothing. +5. After 10 minutes, repeat again from Step 2. + +### Why 10 Minutes? + +So that your CPU won't be burdened with constant process checking. It won't consume any CPU processing power while it's idle and waiting for the 10 minutes to be up. If you want, you can change the check to however often you want. + +## Configuration + +* See **Line 42** if your `Chatterino.exe` is non-standard. +* See **Line 43** to change the path to where your Chatterino is installed. +* See **Line 58** if you want to make the check more frequent or the opposite. + +## Todos + +* Make System Tray Icon actually work