ADD un README pour expliquer le projet et ses fichiers/dossiers

[euphorik.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..7f0a5e1
--- /dev/null
+++ b/README
@@ -0,0 +1,70 @@
+README - EUPHORIK\r
+-----------------\r
+\r
+Ce document a pour but d'introduire le projet Euphorik, de décrire\r
+sa strucure et son utilisation au niveau du développement et de son\r
+utilisation.\r
+\r
+\r
+-- Description --\r
+Euphorik est un site web communautaire développer en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
+\r
+\r
+-- Installation\r
+L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
+est décrit dans le fichier /doc/installation.txt.\r
+\r
+\r
+-- Dossiers / Fichiers --\r
+/index.html\r
+   La page principale du site. Elle est statique.\r
+\r
+/mise_en_prod.rb\r
+   Script permettant la mise en production du site.\r
+   \r
+/BD\r
+   Contient les fichiers lié à la base de données, initialement vide.\r
+   \r
+/css\r
+   Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
+   \r
+/css/common.css\r
+   La feuille de style\r
+   \r
+/doc\r
+   Contient tous les documents de conception (fonctionnel, technique, etc.).\r
+   \r
+/img\r
+   Contient les images du site avec un séparation des images propres à chaque skin.\r
+   Certaines images sont issues de document de conception se trouvant dans /doc/graphiques\r
+   \r
+/js\r
+   Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
+   \r
+/lightbox\r
+   Lib JavaScript permettant d'afficher des images sous la forme de pop-up div.\r
+   \r
+/modules\r
+   Contient la partie serveur.\r
+   \r
+/modules/Makefile\r
+   Règle de compilation des modules du serveur.\r
+   \r
+/modules/ebin\r
+   Contient les modules compilées, initialement vide.\r
+   \r
+/module/erl\r
+   Contient le code sources des différents modules.\r
+   \r
+/modules/include\r
+   Contient certaines définitions (headers).\r
+   \r
+/pages\r
+   Contient certaines pages XHTML qui seront chargée via AJAX.\r
+   \r
+/sessions\r
+   Contient différentes sessions de travail pour le développement avec Scite.\r
+   \r
+\r
+   \r
+   
\ No newline at end of file