X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;h=eac117d5f5b261ff88826da90bb767c1a5a25676;hp=ac0537595d26ce9a940f3c5a209b6915f7fe15b2;hb=7e471788d9356b1cb8659513674df9a883101807;hpb=c07b41feaaec892d7a4995c91719bba7ecbed7a6 diff --git a/README b/README index ac05375..eac117d 100644 --- a/README +++ b/README @@ -1,72 +1,81 @@ -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é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. - +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. +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. + /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. - /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. + /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. + /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. + 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 modaux. - + 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. /modules/Makefile - Règle de compilation des modules du serveur. + Règle de compilation des modules du serveur. /modules/ebin - Contient les modules compilées, initialement vide. + Contient les modules compilées, initialement vide. /module/erl - Contient le code sources des différents modules Erlang. + 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. + Contient certaines pages XHTML qui seront chargée via AJAX. /sessions - Contient différentes sessions de travail pour le développement avec Scite. - - /tool - 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 - - \ No newline at end of file + Contient différentes sessions de travail pour le développement avec Scite. + + /tools + Contient des outils diverses permettant l'aide au développement ou la mise en production. + + /tools/tools.rb + Regoupe un ensemble d'outils permettant : + - La mise en production + - La vérification des fichiers JavaScript à l'aide de 'jslint.js' + - La mise à jour du numéro de version dans les sources à partir de /VERSION + Voir "tools.rb --help" + + /tools/jsmin.rb + Permet la minification du javascript utilisé lors de la mise en production. + + /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