README

README.md

+# Sam
+
+Sam est un bot IRC permettant de gérer un calendrier.
+
+Un événement est composé de :
+  - un titre ;
+  - une date ;
+  - un lieu ;
+  - une description (optionnel) ;
+  - une URL (optionnel).
+
+Sam sait aussi récupérer automatiquement ces informations de certains sites,
+et peut donc remplir lui-même ces champs. Il supporte actuellement les sites
+suivant :
+  - http://www.residentadvisor.net
+
+Enfin Sam permet d'enregistrer la participation à un événement et de voir
+les participants.
+
+## TODO
+
+Par ordre de priorité / faisabilité / difficulté :
+  - notification en query avant la soirée si on y participe
+  - recherche
+  - gérer plus de sites ?
+
+## Contribuer
+
+Le dépôt est disponible ici : (http://git.iiens.net/morignot2011/sam).
+
+Il y a un chan irc : #sam@irc.iiens.net.
+
+Le bot est codé en perl, à l'exception de la partie concernant la récupération
+des infos à partir d'un site qui utilise la librairie Python [Weboob](http://weboob.org/).
+
+Il partage sa structure ainsi que pas mal de code avec
+[PlayBot](http://git.iient.net/morignot2011/playbot), un autre bot IRC. Il faudrait
+d'ailleurs un jour externaliser quelques parties du code et les mettre en commun.