1
0
Fork 0
mirror of https://github.com/em-squared/5e-drs.git synced 2025-10-29 12:44:20 +00:00

licence + documentation + build au deploiement

This commit is contained in:
Maxime Moraine 2020-04-15 17:12:49 +02:00
parent dc30394196
commit 326c69d387
1511 changed files with 720 additions and 20162 deletions

45
README.md Normal file
View file

@ -0,0 +1,45 @@
# Héros & Dragons DRS
Ici se trouvent les sources du Document de Référence Système pour le jeu de rôle Héros & Dragons (H&D).
## Documentation
### Développement
Pour travailler sur le projet, vous devrez au préalable télécharger les sources :
```
git clone git@github.com:em-squared/heros-et-dragons-drs.git
```
Puis installer les dépendances :
```
cd heros-et-dragons-drs
yarn install
```
ou
```
cd heros-et-dragons-drs
npm install
```
Et lancer le service en local :
```
yarn dev
```
ou
```
npm run dev
```
### Production
Pour compiler le projet en vue d'un déploiement, vous devrez vous assurer qu'il ne contient pas de lien internes morts :
```
yarn check-md
```
ou
```
npm run-script check-md
```
Puis lancer la compilation :
```
yarn build
```
ou
```
npm run build
```