X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=README;h=3541f66dce680447ed58b50678de4d2240a64efd;hp=241a0a18d96adcc95f4975ee07d02df1b83e526f;hb=5d9992368bb386d2e606ae037c5478fe10ac70e8;hpb=6bce706bd5b54e83cb22b683fc2184fec9d0a20e diff --git a/README b/README index 241a0a1..3541f66 100644 --- a/README +++ b/README @@ -1,83 +1 @@ -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. - -== 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 == - - /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 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. - - /doc - Contient la documentation (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. - - /js - 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. - - /modules/ebin - Contient les modules compilées, initialement vide. - - /module/erl - Contient le code sources des différents modules Erlang. - - /modules/include - Contient certaines définitions Erlang (headers). - - /pages - Contient certaines pages XHTML qui seront chargée via AJAX. - - /sessions - 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/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 +See : http://dev.euphorik.ch/wiki/euk/Home \ No newline at end of file