MOD avancement dans la Grande Restructuration

[euphorik.git] / README

diff --git a/README b/README
index 576fb98..eac117d 100644 (file)
--- a/README
+++ b/README
@@ -13,23 +13,27 @@ est décrit dans le fichier /doc/installation.txt.
 \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
+ /COPYING\r
+   La licence complète de euphorik.\r
+\r
+/VERSION\r
+   La version courante. Cette chaine est copiée à certains endroit des sources lors de l'execution du script "/tools/copie_num_version.rb"\r
+\r
+ /index.yaws\r
+   La page principale du site. Elle est interprétée par le server HTTP Yaws et possède un petite partie dynamique.\r
    \r
  /BD\r
-   Contient les fichiers lié à la base de données, initialement vide.\r
+   Contient les fichiers de la base de données, initialement vide.\r
+   \r
+ /BD/backups\r
+   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.\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 commune à tous les skins.\r
-   \r
+      \r
  /doc\r
-   Contient tous les documents de conception (fonctionnel, technique, etc.).\r
+   Contient la documentation (fonctionnel, technique, etc.).\r
    \r
  /img\r
    Contient les images du site avec un séparation des images propres à chaque skin.\r
@@ -37,10 +41,7 @@ est décrit dans le fichier /doc/installation.txt.
    \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 modaux.\r
-   \r
+      \r
  /modules\r
    Contient la partie serveur.\r
    \r
@@ -54,7 +55,7 @@ est décrit dans le fichier /doc/installation.txt.
    Contient le code sources des différents modules Erlang.\r
    \r
  /modules/include\r
-   Contient certaines définitions (headers).\r
+   Contient certaines définitions Erlang (headers).\r
    \r
  /pages\r
    Contient certaines pages XHTML qui seront chargée via AJAX.\r
@@ -62,10 +63,19 @@ est décrit dans le fichier /doc/installation.txt.
  /sessions\r
    Contient différentes sessions de travail pour le développement avec Scite.\r
    \r
- /tool\r
+ /tools\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
+ /tools/tools.rb\r
+   Regoupe un ensemble d'outils permettant :\r
+    - La mise en production\r
+    - La vérification des fichiers JavaScript à l'aide de 'jslint.js'\r
+    - La mise à jour du numéro de version dans les sources à partir de /VERSION\r
+   Voir "tools.rb --help"\r
+   \r
+ /tools/jsmin.rb\r
+   Permet la minification du javascript utilisé lors de la mise en production.\r
+      \r
+ /tools/start_yaws.sh\r
+   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.\r
+      
\ No newline at end of file