updated readme

diff --git a/README.md b/README.md
index 8d2e2472a78bbf11ec4952f60b2ff8305004e06f..b97a82dd284d9a3bec97e1d4e87a930af09a9f02 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,16 +2,74 @@
 \r
 Changes the default League of Legends announcer using Live Client Data API. Note that you need to mute the announcer in-game if you don't want overlapping sound.\r
 \r
-## Installation guide\r
+## Build guide\r
 \r
-To install clone the repository and use pip to install it.\r
+Make sure to install the requirements before proceeding\r
+```\r
+pip install -r requirements.txt\r
+```\r
+\r
+To build and install on linux you can run run\r
+```sh\r
+make\r
+sudo make install\r
+```\r
+\r
+or you can build the executable yourself using pyinstaller\r
 ```sh\r
-git clone https://github.com/IHasPeks/peks-announcer\r
-cd peks-announcer\r
-pip install .\r
+pyinstaller cli.py --name "lol-announcer" --add-binary "announcer/sounds:announcer/sounds" --onefile --noconsole\r
 ```\r
 \r
-If developing on this, install it using editable mode instead\r
+On windows you may need to replace the colon with a semicolon\r
 ```sh\r
-pip install -e .\r
+pyinstaller cli.py --name "lol-announcer" --add-binary "announcer/sounds;announcer/sounds" --onefile --noconsole\r
 ```\r
+\r
+## Usage\r
+\r
+To use just have the program open during a game of League of Legends.\r
+It will automatically identify events in the game and will play the\r
+appropriate sound for the event. You will need to mute the in game\r
+announcer, so that you don't get any overlapping sounds.\r
+\r
+## Create Sound Packs\r
+\r
+The program comes bundled with a sound pack. If you want to create your own\r
+you will need to place them in `~/.config/lol-announcer/sounds/your_sound_pack`\r
+on linux, and on windows in `%APPDATA\lol-announcer\sounds\your_sound_pack`.\r
+\r
+Each sound pack should have the following directories and each one should\r
+contain at least one audio file. You may add as many audio files as you\r
+want, a random one will be played during that event.\r
+\r
+Directory | Usage\r
+---|---\r
+FirstBlood | When someone gets the first kill in the game\r
+PlayerKill | When you get a kill\r
+PlayerDeath | When you die\r
+Executed | When you die without getting killed by an enemy\r
+AllyAce | When your team gets an Ace\r
+AllyKill | When your team gets a kill\r
+AllyDeath | When a teammate dies\r
+AllyPentaKill | When your team gets a penta kill\r
+AllyQuadraKill | When your team gets a quadra kill\r
+AllyTripleKill | When your team gets a triple kill\r
+AllyDoubleKill | When your team gets a double kill\r
+AllyTurretKill | When your team destroys a turret\r
+AllyInhibitorKill | When your team destroys an inhibitor\r
+AllyInhibitorRespawned | When your team's inhibitor respawns\r
+AllyInhibitorRespawningSoon | When your team's inhibitor will respawn in 30 seconds\r
+EnemyAce | When the enemy team gets an ace\r
+EnemyPentaKill | When the enemy gets a penta kill\r
+EnemyQuadraKill | When the enemy gets a quadra kill\r
+EnemyTripleKill | When the enemy gets a quadra kill\r
+EnemyDoubleKill | When the enemy team gets a double kill\r
+EnemyTurretKill | When the enemy destroys a turret\r
+EnemyInhibitorKill | When the enemy destroys an inhibitor\r
+EnemyInhibitorRespawned | When the enemy's inhibitor respawns\r
+EnemyInhibitorRespawningSoon | When the enemy's inhibitor will respawn in 30 seconds\r
+Victory | When you win\r
+Defeat | When you lose\r
+Welcome | At the start of the game, about 15 seconds in.\r
+MinionsSpawning | When minions spawn\r
+MinionsSpawningSoon | When minions will spawn in 30 seconds\r