Bla, added install instructions

README.md

@@ -1,68 +1,16 @@
-# Todo
-* [ ] joke Trigger – Erzählt einen schlechten Witz
-* [ ] .seen trigger – returns the last message and date the user was seen in the channel
-
-# Done
-* [x] .help - lists all available commands (builtin)
-* [x] .uptime - prints bot uptime (builtin)
-
-## plugins/admin
-* [x] .reload - reloads a plugin or the whole bot
-
-## plugins/coins
-* [x] .btc - prints current btc values
-* [x] .eth - prints current eth values
-
-## plugins/ctcp
-* [x] .finger - does a FINGER ctcp
-* [x] .ping - does a PING ctcp
-* [x] .time - does a TIME ctcp
-* [x] .ver - does a VERSION ctcp
-
-## plugins/database
-
-## plugins/linux
-* [x] useless gnu/linux event
-* [x] .kernel - displays current linux kernel info
-
-## plugins/mcmaniac
-* [x] regex event for Mc(.*)iaC which adds a McManiaC
-* [x] .mcmaniac - shows a McManiaC (random or by index)
-
-## plugins/quotes
-* [x] .q - prints, adds or removes a quote
-
-## plugins/rape
-* [x] .owe command
-* [x] .rape command
-
-## plugins/seen
-
-## plugins/tell
-* [x] .tell - stores a message for a user and sends it to him when he writes a message in any channel (shows activity)
-
-## plugins/timer
-* [x] .timer - sets a timer for a specified amount of time and a name
-
-## plugins/urban
-* [x] .ud - gets a definition from urban dictionary
-
-## plugins/useless
-* [x] .gay - colors text in rainbow colors
-* [x] .hack - prints "hacking..."
-* [x] .jn - returns yes or no for a given question
-* [x] .kiss - kisses a user
-* [x] .rainbow - same as .gay
-* [x] .storyofpomfface - ....
-* [x] Bier Trigger – nxy schenkt ein kühles blondes an $nick aus
-* [x] REEEEEE Trigger – REEEEEEEEEEEEEEEEEEEEEEEEEEEE
-* [x] Fucken Trigger – nxy fuckt $nick und tötet $nick anschließend.
-* [x] .choose - picks a random entry from a list seperated with commas
-* [x] .sudoku/.anhero - kicks the user that executes that command
-
-## plugins/weather
-* [x] .weather - prints the weather for a given location
-
-## plugins/youtube
-* [x] .yt - search for a video on youtube
-* [x] youtube url parser - returns video information if a youtube link is posted
+# Installation
+* Open shell as user nxy will run
+* Install virtualenvwrapper and source it
+  - ```source $(which virtualenvwrapper.sh)```
+* Clone repo
+  - ```git clone https://gitfap.de/mrhanky/nxy.git```
+* Create virtualenv and install dependencies
+  - ```mkvirtualenv -a $PWD/nxy -r $PWD/nxy/requirements.txt nxy```
+* Copy ```.env-example``` and insert values in ```.env``` (replace everything wrapped in < and >)
+  - ```cp .env-example .env```
+  - ```vim .env```
+* Leave (auto) activated virtualenv and
+  - ```deactivate```
+* Copy systemd unit (would recommend the ```/usr/local``` prefix)
+  - ```sudo mkdir -p /usr/local/lib/systemd/system```
+  - ```sudo cp $PWD/nxy/nxy-bot.service /usr/local/lib/systemd/system```