(no commit message)

[euphorik.git] / README

diff --git a/README b/README
index 7f0a5e1..1756819 100644 (file)
--- a/README
+++ b/README
@@ -1,70 +1,71 @@
-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
 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
+== Description ==\r
+Euphorik est un site web communautaire développé en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
+Il utilise massivement le javascript et l'AJAX coté client.\r

 \r
 \r

--- Installation\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
 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
+== Dossiers / Fichiers ==\r
+ /index.html\r

    La page principale du site. Elle est statique.\r
 \r
    La page principale du site. Elle est statique.\r
 \r

-/mise_en_prod.rb\r
+ /mise_en_prod.rb\r

    Script permettant la mise en production du site.\r
    \r
    Script permettant la mise en production du site.\r
    \r

-/BD\r
+ /BD\r

    Contient les fichiers lié à la base de données, initialement vide.\r
    \r
    Contient les fichiers lié à la base de données, initialement vide.\r
    \r

-/css\r
+ /css\r

    Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
    \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
+ /css/common.css\r
+   La feuille de style commune à tous les skins.\r

    \r
    \r

-/doc\r
+ /doc\r

    Contient tous les documents de conception (fonctionnel, technique, etc.).\r
    \r
    Contient tous les documents de conception (fonctionnel, technique, etc.).\r
    \r

-/img\r
+ /img\r

    Contient les images du site avec un séparation des images propres à chaque skin.\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
+   Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.\r

    \r
    \r

-/js\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
    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
+ /lightbox\r
+   Lib JavaScript permettant d'afficher des images sous la forme de pop-up modaux.\r

    \r
    \r

-/modules\r
+ /modules\r

    Contient la partie serveur.\r
    \r
    Contient la partie serveur.\r
    \r

-/modules/Makefile\r
+ /modules/Makefile\r

    Règle de compilation des modules du serveur.\r
    \r
    Règle de compilation des modules du serveur.\r
    \r

-/modules/ebin\r
+ /modules/ebin\r

    Contient les modules compilées, initialement vide.\r
    \r
    Contient les modules compilées, initialement vide.\r
    \r

-/module/erl\r
-   Contient le code sources des différents modules.\r
+ /module/erl\r
+   Contient le code sources des différents modules Erlang.\r

    \r
    \r

-/modules/include\r
+ /modules/include\r

    Contient certaines définitions (headers).\r
    \r
    Contient certaines définitions (headers).\r
    \r

-/pages\r
+ /pages\r

    Contient certaines pages XHTML qui seront chargée via AJAX.\r
    \r
    Contient certaines pages XHTML qui seront chargée via AJAX.\r
    \r

-/sessions\r
+ /sessions\r

    Contient différentes sessions de travail pour le développement avec Scite.\r
    \r
    Contient différentes sessions de travail pour le développement avec Scite.\r
    \r

-\r
+ /tool\r
+   Contient des outils diverses permettant l'aide au développement ou la mise en production.\r
+   \r
+ /tool/jsmin.rb\r
+   Permet la minification du javascript utilisé lors de la mise en production\r

    \r
    
\ No newline at end of file
    \r
    
\ No newline at end of file