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

diff --git a/README b/README
index 7f0a5e1..241a0a1 100644
--- a/README
+++ b/README
@@ -1,70 +1,83 @@
-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
+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.
+== Description ==
+Euphorik est un site web communautaire développé en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.
+Il utilise massivement le javascript et l'AJAX coté client.
 
+== 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.
 
--- 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 ==
 
--- Dossiers / Fichiers --
-/index.html
-   La page principale du site. Elle est statique.
+ /COPYING
+   La licence complète de euphorik.
 
-/mise_en_prod.rb
-   Script permettant la mise en production du site.
+/VERSION
+   La version courante. Cette chaine est copiée à certains endroit des sources lors de l'execution du script "/tools/copie_num_version.rb"
+
+ /index.yaws
+   La page principale du site. Elle est interprétée par le server HTTP Yaws et possède un petite partie dynamique.
+   
+ /BD
+   Contient les fichiers de la base de données, initialement vide.
    
-/BD
-   Contient les fichiers lié à la base de données, initialement vide.
+ /BD/backups
+   Contient les backups de la base de données. A chaque changement de version de la base un backup est effectué, il est nommé "backup<num>" ou <num> est le numéro de version.
    
-/css
-   Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.
+ /css
+   Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.
+      
+ /doc
+   Contient la documentation (fonctionnel, technique, etc.).
    
-/css/common.css
-   La feuille de style
+ /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.
    
-/doc
-   Contient tous les documents de conception (fonctionnel, technique, etc.).
+ /js
+   Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js
+      
+ /modules
+   Contient la partie serveur.
    
-/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
+ /modules/Makefile
+   Règle de compilation des modules du serveur.
    
-/js
-   Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js
+ /modules/ebin
+   Contient les modules compilées, initialement vide.
    
-/lightbox
-   Lib JavaScript permettant d'afficher des images sous la forme de pop-up div.
+ /module/erl
+   Contient le code sources des différents modules Erlang.
    
-/modules
-   Contient la partie serveur.
+ /modules/include
+   Contient certaines définitions Erlang (headers).
    
-/modules/Makefile
-   Règle de compilation des modules du serveur.
+ /pages
+   Contient certaines pages XHTML qui seront chargée via AJAX.
    
-/modules/ebin
-   Contient les modules compilées, initialement vide.
+ /sessions
+   Contient différentes sessions de travail pour le développement avec Scite.
    
-/module/erl
-   Contient le code sources des différents modules.
+ /tools
+   Contient des outils diverses permettant l'aide au développement ou la mise en production.
    
-/modules/include
-   Contient certaines définitions (headers).
+ /tools/copie_num_version.rb
+   Copie le contenu de /VERSION à différents endroits des sources, entre autre dans /pages/about.html
    
-/pages
-   Contient certaines pages XHTML qui seront chargée via AJAX.
+ /tools/jsmin.rb
+   Permet la minification du javascript utilisé lors de la mise en production.
    
-/sessions
-   Contient différentes sessions de travail pour le développement avec Scite.
+ /tools/mise_en_prod.rb
+   Script permettant la mise en production du site.
    
-
+ /tools/mise_en_prod.erl
+   Script Erlang exécuté sur le serveur lors de la mise en prod et effectuant des opérations tel que le rechargement des modules et le déclanchement de la mise à jour de la BD.
    
+ /tools/start_yaws.sh
+   Script shell permettant de lancer Yaws, utilisé uniquement pour le développement. Il faut s'assuré que Yaws n'est pas déjà démarré comme daemon avec d'exécuter ce script.
    
\ No newline at end of file