ADD un README pour expliquer le projet et ses fichiers/dossiers
[euphorik.git] / README
1 README - EUPHORIK\r
2 -----------------\r
3 \r
4 Ce document a pour but d'introduire le projet Euphorik, de décrire\r
5 sa strucure et son utilisation au niveau du développement et de son\r
6 utilisation.\r
7 \r
8 \r
9 -- Description --\r
10 Euphorik est un site web communautaire développer en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
11 \r
12 \r
13 -- Installation\r
14 L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
15 est décrit dans le fichier /doc/installation.txt.\r
16 \r
17 \r
18 -- Dossiers / Fichiers --\r
19 /index.html\r
20    La page principale du site. Elle est statique.\r
21 \r
22 /mise_en_prod.rb\r
23    Script permettant la mise en production du site.\r
24    \r
25 /BD\r
26    Contient les fichiers lié à la base de données, initialement vide.\r
27    \r
28 /css\r
29    Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
30    \r
31 /css/common.css\r
32    La feuille de style\r
33    \r
34 /doc\r
35    Contient tous les documents de conception (fonctionnel, technique, etc.).\r
36    \r
37 /img\r
38    Contient les images du site avec un séparation des images propres à chaque skin.\r
39    Certaines images sont issues de document de conception se trouvant dans /doc/graphiques\r
40    \r
41 /js\r
42    Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
43    \r
44 /lightbox\r
45    Lib JavaScript permettant d'afficher des images sous la forme de pop-up div.\r
46    \r
47 /modules\r
48    Contient la partie serveur.\r
49    \r
50 /modules/Makefile\r
51    Règle de compilation des modules du serveur.\r
52    \r
53 /modules/ebin\r
54    Contient les modules compilées, initialement vide.\r
55    \r
56 /module/erl\r
57    Contient le code sources des différents modules.\r
58    \r
59 /modules/include\r
60    Contient certaines définitions (headers).\r
61    \r
62 /pages\r
63    Contient certaines pages XHTML qui seront chargée via AJAX.\r
64    \r
65 /sessions\r
66    Contient différentes sessions de travail pour le développement avec Scite.\r
67    \r
68 \r
69    \r
70