Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolandu authored Jul 19, 2024
1 parent 521c461 commit 52b31f7
Showing 1 changed file with 52 additions and 7 deletions.
59 changes: 52 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*English version below.*
# À 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
Expand All @@ -6,19 +7,25 @@ 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 8<sup>e</sup> ébauche de l'année
`MAJEUR.MINEUR` (par exemple, `0.8` est la 8<sup>e</sup> ébauche de l'année
et `1.7` est la 7<sup>e</sup> révision de la 1<sup>re</sup> version
de l'année), ce qui est équivalent à SemVer sans l'info de correctifs.
de l'année), ce qui est équivalent à [SemVer](https://semver.org/lang/fr/)
sans l'info de `CORRECTIF`.

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).
Les noms de tags GitHub sont de la forme `ANNÉE.MAJEUR.MINEUR`
(par exemple, `2024.1.7` est la version `1.7` de l'année 2024).

## Définition d'une année
Les années utilisées sont les années de saison FRC. Par exemple, l'année
2024 va de la pré-saison (fin 2023) au championnat 2024.

# Contributions
Si vous avez vos propres schémas de composantes, il nous fera plaisir
que vous les ajoutiez à la librairie `FRC_Components`!
que vous les ajoutiez à la librairie `FRC_Components`! Basez-vous sur
les composantes existantes pour avoir des exemples!

# Langues
La librairie de composantes est en anglais, afin de permettre son
La librairie de composantes est en anglais, en raison, notamment, de 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
Expand All @@ -27,10 +34,48 @@ 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
de composantes) repart à neuf à chaque année!

**Partagé avec ❤️ par**

<img src="logo.png" alt="Logo ASTRO" width="200" />

# 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.

## Versioning convention
`MAJOR.MINOR`, (for example, `0.8` is the 8<sup>th</sup> draft of the
year and `1.7` is the 7<sup>th</sup> revision of the 1<sup>st</sup>
version of the year), which is equivalent to [SemVer](https://semver.org)
without the `PATCH`info.

GitHub tag names are form `YEAR.MAJOR.MINOR` (for example, `2024.1.7` is
version `1.7` of the year 2024).

### Definition of a year
The years used are the FRC season years. For examples, year 2024 goes
from pre-season (end of 2023) to the 2024 championship.

## Contributing
If you have your own component schematics, we will be pleased if
you add them to the `FRC_Components` library! Use the existing
components as templates/examples!

## Languages
The component library is in English, given, notably, its universality
within the FRC community, and ASTRO's schematics are in French to
facilitate their legibility within the team. It is desired that your
additions to the component library be made in English; if that isn't
the case, please mention it in your PR so we can translate them.
Thank you for your understanding!

## How to check previous years' schematics
Look at past commits/tags, as the schematic (not the component library)
gets a fresh start every year!

**Shared with ❤️ by**

<img src="logo.png" alt="ASTRO logo" width="200" />

0 comments on commit 52b31f7

Please sign in to comment.