cours/README.md
2022-12-05 01:02:03 +01:00

59 lines
1.4 KiB
Markdown

Notes de cours et TD machine
-----------------------------
Dépôt git pour la construction d'un site statique avec
[Hugo](https://gohugo.io) reprenant l'ensemble de mes notes de cours et TM
machine mises au propre (J'ai beaucoup de retard...)
Le projet dispose d'un *Makefile* afin d'utiliser `make` pour la génération des
fichiers et le déploiement.
## Construction du site
### Installer le thème
Pour que la construction du site fonctionne, il faut installer le thème
mainroad. Il est présent sous la forme d'un `submodule` git qu'il faut
initialiser (dans le répertoire racine du dépôt).
```shell
git submodule init && git submodule update
```
### Version locale du site
Pour construite le site, il faut au préalable installer hugo, sur Archlinux :
```shell
pacman -S hugo
```
Pour activer le serveur web intégré à Hugo, il suffit de lancer la commande
(dans le répertoire racine du dépôt) :
```shell
$ make serve
```
Pour construire les fichiers statiques du site, il suffit de faire:
```
make build
```
## Déploiement
Une fois le site construit, il est possible de le déployer en utilisant la
cible `deploy`. Il faut auparavant créer le fichier `include.mk` à la racine de
projet avec les variables suivante:
```makefile
DEPLOY_SERVER=monserveur.example.com
DEPLOY_FOLDER=~/www/lpro/
```
Puis lancer la commande:
```
make deploy
```