https://github.com/kerogs/bras
https://github.com/kerogs/bras
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/kerogs/bras
- Owner: kerogs
- License: apache-2.0
- Created: 2024-03-25T21:27:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T22:18:59.000Z (about 2 years ago)
- Last Synced: 2024-05-29T01:15:56.227Z (about 2 years ago)
- Language: C++
- Size: 15.4 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
B.R.A.S
Projet BRAS - Code et Documentation.
### Language de programmation
### Documentation
### Conception
### Marque Composants
### Marque Composant intégré
### Marque Equipement
### Hébergement
## Installation
1. Effectuer la commande suivante pour cloner le repository
```sh
git clone https://github.com/kerogs/bras.git
```
## Accès à la documentation
Pour simplement ouvrir et consulter la documentation :
1. Rendez vous sur le site de la documentation [ks-infinite.fr](https://bras.ks-infinite.fr/)
- Ou alors Passer à l'étape ***Modification et lancement de la documentation*** pour la version self hosted
## Modification et lancement de la documentation
Pour lancer la documentation en local et effectuer des modifications :
1. Installez ``NodeJS`` via [ce lien](https://nodejs.org/en/download/current)
2. Clone le repository
```sh
git clone https://github.com/kerogs/bras.git
```
2. Accédez au dossier ``/docs/``
```sh
cd docs
```
3. Installer les packages
```sh
npm install
```
4. Exécutez la commande suivante pour lancer la documentation en local :
```sh
npm run docs:dev
```
Une fois le chargement terminé, une adresse IP locale avec son port sera affichée. Ouvrez cette adresse dans un navigateur web pour accéder à la documentation.
Tous les fichiers de documentation sont rédigés au format Markdown, mais fonctionnent sous VitePress. Vous pouvez donc vous renseigner sur la personnalisation de VitePress.
## Code arduino
Tout le code Arduino est situé dans le dossier ``/public/code/``. Le code principal se trouve dans ``/public/code/main.ino``. Il existe une partie qui s'appelle ``admin.ino`` qui sert à tester l'intégralité du code. La documentation des commandes est disponible dans la section ADR dans la version du code admin choisis.
### Modifications
***Voici la liste des éléments à ajouter :***
- Intégrer votre nouvelle version de code dans le dossier ADR et la lier à son fichier ``/docs/ADR/index.md``.
- Toute ajout de fonction, variable ou dépendance.
Avant d'apporter des modifications, veuillez mettre à jour la documentation. Si vous souhaitez générer la documentation au format HTML et la placer dans ``/public/docs/`` exécutez la commande suivante :
```bash
npm run docs:build
```
Si vous modifiez la sortie de la documentation, pensez également à modifier le chemin d'accès dans le fichier ``/docs/.vitepress/config.mts``
```ts
export default {
outDir: '../public/docs'
}
```
Si vous modifiez la sortie de la documentation, pensez également à modifier le chemin d'accès dans le fichier ``/docs/.vitepress/config.mts``
```ts
export default {
base: '/public/docs/',
}
```
## Utilisation de la documentation.
Le code embarque avec lui une version selfhosted de la documentation. Pour cela, il vous suffit d'effectuer les commandes suivantes :
- Accédez au dossier ``/docs/``
```sh
cd docs
```
- Exécutez la commande suivante pour build la documentation :
```sh
npm run docs:build
```
- Ou le faire en 1 commande
```sh
cd .\docs\; npm run docs:build
```
- Il vous suffit donc maintenant d'héberger en local les fichiers HTML (important pour le chargement du CSS)
## Schéma + Shield
## License
Licence Apache 2.0 (voir le fichier LICENSE)
[](https://opensource.org/licenses/Apache-2.0)