enrichie le readme

README.md

@@ -1 +1,50 @@
-## Simple IRC Bot statusing icinga2 via its API.
+# Icinga Bot
+
+Simple IRC Bot statusing icinga2 via its API.
+
+**Table of content**
+
+- [Installation](#installation)
+- [Licence](#licence)
+
+## Installation
+### Requirements
+
+On a Debian-based host - running at least Debian Stretch, you will need the
+following packages:
+- git (recommended for getting the source)
+- python3
+- python3-irc
+- python3-requests
+
+### Manual installation
+
+1.  Clone repo in /srv/
+
+        $ cd /srv && git clone https://forge.april.org/adminsys/icingabot
+        $ chmod a+x icingabot/icingabot.py
+
+2.  Install the configuration in etc
+
+        $ mkdir /etc/icingabot
+        $ cp icingabot/icingabot.conf /etc/icingabot/
+
+3.  Configure the application
+
+        $ $EDITOR /etc/icingabot/icingabot.conf
+
+4.  Try it
+
+        $ ./icingabot/icingabot.py
+
+5.  Install a launcher
+
+        $ cp icingabot/icingabot.service /etc/systemd/system/
+
+6.  Start it
+
+        $ systemctl start icingabot/icingabot
+
+## License
+
+GvoT is developed by Cliss XXI and licensed under the [AGPLv3+](LICENSE).