X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;fp=README;h=04e1564ee55bb090ce05703bb934196d1c06134e;hp=7f0a5e1c44e5f73ff6665288977d7ec676f7ac1f;hb=c869eb8c57d0319370147d1093a263efa683e4a9;hpb=7ed3a03bffb4112ee174b05ef1d7b486d6ad6534 diff --git a/README b/README index 7f0a5e1..04e1564 100644 --- a/README +++ b/README @@ -1,70 +1,72 @@ -README - EUPHORIK ------------------ +== 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 utilisation. --- Description -- +== Description == Euphorik est un site web communautaire développer en Erlang pour le serveur Yaws et utilisant la base de données Mnesia. --- Installation +== 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 -- -/index.html +== Dossiers / Fichiers == + /index.html La page principale du site. Elle est statique. -/mise_en_prod.rb + /mise_en_prod.rb Script permettant la mise en production du site. -/BD + /BD Contient les fichiers lié à la base de données, initialement vide. -/css + /css Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin. -/css/common.css + /css/common.css La feuille de style -/doc + /doc Contient tous les documents de conception (fonctionnel, technique, etc.). -/img + /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 -/js + /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 + /lightbox Lib JavaScript permettant d'afficher des images sous la forme de pop-up div. -/modules + /modules Contient la partie serveur. -/modules/Makefile + /modules/Makefile Règle de compilation des modules du serveur. -/modules/ebin + /modules/ebin Contient les modules compilées, initialement vide. -/module/erl + /module/erl Contient le code sources des différents modules. -/modules/include + /modules/include Contient certaines définitions (headers). -/pages + /pages Contient certaines pages XHTML qui seront chargée via AJAX. -/sessions + /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/minjs.rb + Permet la minification du javascript utilisé lors de la mise en production \ No newline at end of file