X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;h=241a0a18d96adcc95f4975ee07d02df1b83e526f;hp=576fb98d20c226392c3884d999272ab5ad2667c2;hb=f5b818cf316c6ccae89dac192411a4d875a0c6b4;hpb=7a5497fe66ee5318962dd5dde9f274bedb376e5d diff --git a/README b/README index 576fb98..241a0a1 100644 --- a/README +++ b/README @@ -13,23 +13,27 @@ 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. + /COPYING + La licence complète de euphorik. + +/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 lié à la base de données, initialement vide. + Contient les fichiers de 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" ou 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/common.css - La feuille de style commune à tous les skins. - + /doc - Contient tous les documents de conception (fonctionnel, technique, etc.). + Contient la documentation (fonctionnel, technique, etc.). /img Contient les images du site avec un séparation des images propres à chaque skin. @@ -37,10 +41,7 @@ est décrit dans le fichier /doc/installation.txt. /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 modaux. - + /modules Contient la partie serveur. @@ -54,7 +55,7 @@ est décrit dans le fichier /doc/installation.txt. Contient le code sources des différents modules Erlang. /modules/include - Contient certaines définitions (headers). + Contient certaines définitions Erlang (headers). /pages Contient certaines pages XHTML qui seront chargée via AJAX. @@ -62,10 +63,21 @@ est décrit dans le fichier /doc/installation.txt. /sessions Contient différentes sessions de travail pour le développement avec Scite. - /tool + /tools Contient des outils diverses permettant l'aide au développement ou la mise en production. - /tool/jsmin.rb - Permet la minification du javascript utilisé lors de la mise en production + /tools/copie_num_version.rb + Copie le contenu de /VERSION à différents endroits des sources, entre autre dans /pages/about.html + + /tools/jsmin.rb + Permet la minification du javascript utilisé lors de la mise en production. + + /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