X-Git-Url: http://git.euphorik.ch/?p=pompage.git;a=blobdiff_plain;f=README;fp=README;h=f5642b0ff22cb9f57bfb444e240f34692c10a46f;hp=0000000000000000000000000000000000000000;hb=2c39e91dbb4c0b185e4adb08faf9562cf58e45af;hpb=2a7ec6f7fdb8937c2a8c9581bc6517faee94aecb

diff --git a/README b/README
new file mode 100755
index 0000000..f5642b0
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+- YopYop -
+
+Yopyop est un ensemble de scripts permettant de maintenir à jour une liste de films au format XML.
+
+
+- Introduction
+
+Un programme Ruby (lancé par 'start.bat') permet à partir d'un dossier contenant des films de peupler un fichier XML. Ces deux paramètres sont passés en option 'src/yopyop.rb'.
+Ce script va demander de charger un maximum d'information au module courant, par défaut 'Allocine'. Ce module va obtenir des informations à partir du site "www.allocine.fr". Les modules se trouvent dans le répertoire 'src/modules'. Il est possible de créer d'autres modules en se basant sur "allocine.rb".
+
+Le fichier XML se base sur un feuille XSL pour permettre son affichage, de ce fait il est tout à fait possible d'utiliser un navigateur pour "voir" le XML, il est fortmement recommandé d'utiliser Firefox. La feuille de style se trouve ici : "xsl/yopyop.xsl". Cette feuille génère un contenu de type XHTML contenant du javascript et utilisant un feuille CSS. Le fichier javascript se trouve ici : "js/yopyop.js" et la feuille CSS ici : "css/yopyop.css".
+
+Le repertoire "img" contient toutes les images que l'XHTML
+
+
+-