X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;h=576fb98d20c226392c3884d999272ab5ad2667c2;hp=04e1564ee55bb090ce05703bb934196d1c06134e;hb=090d64f838782473402a436448174db3d058f6da;hpb=c869eb8c57d0319370147d1093a263efa683e4a9 diff --git a/README b/README index 04e1564..576fb98 100644 --- a/README +++ b/README @@ -1,17 +1,15 @@ -== 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. - +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 == @@ -22,51 +20,52 @@ est d Script permettant la mise en production du site. /BD - Contient les fichiers lié à la base de données, initialement vide. + Contient les fichiers lié à 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. + 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 + La feuille de style commune à tous les skins. /doc Contient tous les documents de conception (fonctionnel, technique, etc.). /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 + 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 + 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 div. + Lib JavaScript permettant d'afficher des images sous la forme de pop-up modaux. /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. + Contient le code sources des différents modules Erlang. /modules/include - Contient certaines définitions (headers). + Contient certaines définitions (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. + 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/minjs.rb - Permet la minification du javascript utilisé lors de la mise en production + 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