summaryrefslogtreecommitdiff
path: root/d
diff options
context:
space:
mode:
authorschodet2005-06-12 19:40:17 +0000
committerschodet2005-06-12 19:40:17 +0000
commit29e76879a895b3e99c7b9e090c0f741efe864f39 (patch)
tree6bc52e348db0b13e7b12d83321e4e7187e3cd4e7 /d
parent63e383181b45d24b8c71a00f3337910655f99f50 (diff)
Ajout de la doc sur l'arborescence.
Diffstat (limited to 'd')
-rw-r--r--d/quality/tree.txt171
1 files changed, 171 insertions, 0 deletions
diff --git a/d/quality/tree.txt b/d/quality/tree.txt
new file mode 100644
index 0000000..2c238e1
--- /dev/null
+++ b/d/quality/tree.txt
@@ -0,0 +1,171 @@
+*Title: Arborescence de développement
+*Author: Ni
+
+*TOC
+
+* Partie analogique : |a|
+
+L'arborescence |a| regroupe les développements concernant les cartes
+électroniques analogiques. Chaque carte a son répertoire ''carte'' contenant :
+
+ [README] qui décrit la carte ;
+ [''carte''.txt] au format AFT qui documente la carte de manière plus
+ précise, au niveau utilisation, conception et réalisation ;
+ [''carte''.brd et ''carte''.sch] les fichiers Eagle du circuit
+ imprimé.
+
+Les bibliothèques Eagle ne sont en général pas à mettre dans le répertoire de
+la carte. Le répertoire peut contenir des fichiers supplémentaires comme par
+exemple les fichiers d'un circuit imprimé d'adaptateur.
+
+Exemple :
+
+^<<
+puiss/
+ README
+ puiss.txt
+ puiss.brd
+ puiss.sch
+^>>
+
+* Partie numérique : |n|
+
+L'arborescence |n| regroupe les développements concernant les cartes
+électroniques numériques. Chaque carte a son répertoire ''carte'' contenant :
+
+ [README] qui décrit la carte ;
+ [pcb/] qui contient le circuit imprimé ;
+ [src/] qui contient les sources des programmes concernant la carte.
+
+Le répertoire |pcb| contient :
+
+ [''carte''.txt] au format AFT qui documente la carte de manière plus
+ précise, au niveau utilisation, conception et réalisation ;
+ [''carte''.brd et ''carte''.sch] les fichiers Eagle du circuit
+ imprimé.
+
+Le répertoire |src| contient :
+
+ [''carte''.txt ou ''logiciel''.txt] au format AFT qui documente le
+ code de manière plus précise, au niveau utilisation et conception ;
+ [les sources] C ou Verilog par exemple, avec le Makefile qui permet de
+ les compiler et les programmes de test ou testbench.
+
+Le répertoire |src| peut être sous-divisé en plusieurs répertoires pour chaque
+solution logicielle, si par exemple il y a plusieurs composant à programmer,
+des programmes qui tournent sur PC ou différents programmes pour le même
+composant.
+
+Exemple :
+
+^<<
+asserv/
+ README
+ pcb/
+ asserv.brd
+ asserv.sch
+ adapt.brd
+ adapt.sch
+ src/
+ qdecod/
+ Makefile
+ qdecod.txt
+ qdecod.v
+ ...
+ asserv/
+ Makefile
+ asserv.txt
+ asserv.c
+ ...
+^>>
+
+Cette arborescence contient aussi |avr_modules| pour les modules AVR.
+
+* Partie informatique : |i|
+
+L'arborescence |i| regroupe les développements informatiques. Chaque programme
+a son répertoire avec au minimum son fichier |README|. Le reste de
+l'arborescence varie selon les projets.
+
+* Partie mécanique : |m|
+
+L'arborescence |m| regroupe les développements mécaniques.
+
+TODO: A compléter.
+
+* Outils et méthodes de développement : |d|
+
+L'arborescence |d| contient les outils et les méthodes utilisés pour
+développer le robot. Il contient entre autre :
+
+ [sys] pour le serveur de développement, son utilisation, ses scripts,
+ sa page web, etc.
+ [tools] qui contient des outils de développement, des scripts, des
+ fichiers de configuration, des manuels, etc.
+ [quality] qui contient les documents relatifs à l'assurance qualité
+ (standards, faq, check-lists...).
+
+* Management de projet : |p|
+
+L'arborescence |p| contient les documents produit de la gestion de projet
+ainsi que ceux expliquant son fonctionnement. On y trouve notament :
+
+ [doc] qui explique comment la gestion de projet fonctionne ;
+ [reu] avec le compte rendu des réunions ;
+ [todo] avec la todolist et le bugtracking ;
+ [reports] avec les rapports hebdo des développeurs.
+
+* Bureau de l'association : |b|
+
+L'arborescence |b| appartient au bureau de l'association et regroupe les
+documents qui n'ont pas de rapport avec le développement. On y trouve aussi
+la liste des membres avec leur rôles, leur pseudo et leur coordonnées. Ce
+n'est donc pas la peine de préciser les coordonnées de l'auteur dans chaque
+document.
+
+* Arborescence Subversion
+
+L'arborescence subversion se trouve dans |/svn|. La racine contient trois
+répertoires : |trunk|, |tags| et |branches| comme préconisé par le manuel de
+Subversion. Ces trois répertoires sont tous structurés selon la même
+arborescence.
+
+Il y a aussi une arborescence |/svntest| pour ceux qui ne connaissent pas
+bien Subversion et qui voudraient faire des test.
+
+* Le fichier |README|
+
+Ce fichier doit contenir, sur la premiere ligne le nom du projet (programme ou
+carte), suivit d'un tiret et d'une description succinte. Par exemple :
+
+^<<
+asserv - Asservissement de position et de vitesse sur AVR.
+^>>
+
+Cette ligne sera automatiquement insérée dans les codes sources (voir
+|d/quality/code/standards|.
+
+Il doit ensuite contenir une description plus détaillée, et la licence de la
+carte ou du programme, c'est à dire la GPL, sous la forme :
+
+^<<
+Copyright (C) <année> <auteur>
+
+Robot APB Team/Efrei 2005.
+ Web: http://assos.efrei.fr/robot/
+ Email: robot AT efrei DOT fr
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+^>>