mirror of
https://github.com/ae-utbm/sith.git
synced 2024-12-23 16:21:22 +00:00
44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
|
# Documentation du site de l'association des étudiants de l'UTBM
|
||
|
|
||
|
Bonjour, camarade.
|
||
|
|
||
|
Si tu es ici, c'est sans doute pour mieux connaitre
|
||
|
le fonctionnement interne du site AE.
|
||
|
Peut-être même as-tu envie de contribuer à son développement.
|
||
|
Si tel est le cas, nous ne pouvons faire autrement
|
||
|
que te souhaiter la bienvenue sur cette documentation
|
||
|
et espérer que ce que nous avons écrit est assez
|
||
|
clair et assez complet pour satisfaire ton esprit
|
||
|
en quête de connaissances.
|
||
|
|
||
|
Et si tu viens pour d'autres motifs,
|
||
|
ça ne change rien, soit le bienvenu (ou la bienvenue)
|
||
|
quand même.
|
||
|
|
||
|
Pour que tu saches où chercher quelles informations,
|
||
|
voici comment nous avons découpé la documentation :
|
||
|
|
||
|
- Dans un premier temps, les explications, où nous
|
||
|
discutons tout simplement de ce à quoi nous pensions
|
||
|
en faisant ceci ou cela, quels motifs ont guidé tel ou
|
||
|
tel choix...
|
||
|
Bref, nous discutons du projet en tant qu'ensemble
|
||
|
de choix, qu'en tant qu'accumulation de détails
|
||
|
techniques.
|
||
|
Des détails techniques, tu en trouveras quand même,
|
||
|
mais sans doute moins que dans les autres parties.
|
||
|
- Deuxièmement, les tutoriels, où nous
|
||
|
expliquons pas à pas comment installer le
|
||
|
projet et commencer à travailler dessus.
|
||
|
Vois-le comme une notice d'assemblage.
|
||
|
- Troisièmement, les recettes, ou *how-to*,
|
||
|
où nous présenterons des conseils, des procédures à suivre
|
||
|
et des patterns qui t'aideront peut-être.
|
||
|
- Enfin, la référence, où sera donnée en dur
|
||
|
les détails techniques les plus intimes du projet,
|
||
|
tirés directement du code,
|
||
|
qui ne seront sans doute pas d'une grande utilité
|
||
|
pour comprendre le projet dans sa globalité,
|
||
|
mais qui seront bien plus utiles pour appréhender
|
||
|
l'implémentation de telle ou telle partie du code.
|