X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;fp=README;h=7f0a5e1c44e5f73ff6665288977d7ec676f7ac1f;hp=0000000000000000000000000000000000000000;hb=3d3bb0ea14b30705c2a26a1117374e6568ba59bb;hpb=3bd76df122c257d6bfda6619f95f7a207f458d47

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