diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f202e5 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# À propos +Ce dépot Git regorge de ressources en matière de schémas de câblage +et de schémas de composantes (moteurs, contrôleurs et composantes +électriques/électroniques) utilisées pour FRC. Il est composé d'une +librairie de composantes KiCad et d'un schéma (dans Eeschema) pour +l'année en cours. + +# Convention de versionnement +`MAJEUR.mineur` (par exemple, `0.8` est la 8e ébauche de l'année +et `1.7` est la 7e révision de la 1re version +de l'année), ce qui est équivalent à SemVer sans l'info de correctifs. + +Les noms de tags GitHub sont `ANNÉE.MAJEUR.mineur` (par exemple, +`2024.1.7` est la version `1.7` de l'année 2024). + +# Contributions +Si vous avez vos propres schémas de composantes, il nous fera plaisir +que vous les ajoutiez à la librairie `FRC_Components`! + +# Langues +La librairie de composantes est en anglais, afin de permettre son +universalité à travers la communauté FRC, et les schémas d'ASTRO sont +en français pour faciliter leur lisibilité au sein de l'équipe. Il est +souhaité que vos additions à la librairie de composantes soient faites +en anglais; si ce n'est pas le cas, veuillez nous en aviser dans votre +PR afin que nous puissions les traduire. Merci de votre compréhension! + +# Comment voir les années précédentes? +Regardez les commits/tags précédents, car le schéma (pas la librairie +de composantes) repart à neuf à cha + +# English +## About +This Git repository is full of resources for FRC wiring and components +schematics. It is composed of a KiCad component library and a (Eeschema) +schematic for the current year.