Browse Source

un petit README ne fait pas de mal

Vigdis (DanJ) 10 years ago
parent
commit
201201f327
1 changed files with 20 additions and 0 deletions
  1. 20 0
      README.md

+ 20 - 0
README.md

@@ -0,0 +1,20 @@
+# UneFede
+
+C'est un bot irc qui (pour l'instant) seulement présent sur le chan #ffdn. Il
+répond à quelques commandes. 
+
+# Fonctionnement
+
+Trois scripts  :
+
+* unefede.pl (basé sur Bot::BasicBot) qui se connecte à irc et lit à
+  partir de fichier plat
+* feed.ksh qui se contente juste de télécharger les json
+* json-file.pl qui va parser les json et écrire dans les fichiers lus
+  par unefede.pl
+
+Seuls ces deux derniers ont intérêt à être dans cron(8).
+
+# Autre
+
+Je complèterai ce readme avec les réponses des questions qu'on me pose :p