Add 'Create template project' doc

This commit is contained in:
wpetit 2020-05-23 12:27:11 +02:00
parent 34cae8e206
commit a898b0c1a3
3 changed files with 20 additions and 3 deletions

View File

@ -60,6 +60,7 @@ OPTIONS:
## Documentation
- [Créer un modèle de projet](./doc/create_project_template.md)
- [Format du fichier `scaffold.yml`](./doc/scaffold_file_format.md)
## Licence

View File

@ -0,0 +1,19 @@
# Créer un nouveau modèle de projet
Un modèle de projet `scaffold` est un simple répertoire. Celui ci peut être versionné avec Git et utilisé de manière distante par la commande `scaffold from`.
## Fichiers gabarits ("templates")
Tout fichier dont l'extension est `.gotpl` se verra transformé avec la librairie [`text/template`](https://golang.org/pkg/text/template/) avant d'être copié.
L'extension `.gotpl` sera supprimée avant la copie (_par exemple, un fichier `index.html.gotpl` sera transformé puis copié en `index.html`_).
Les variables déclarées dans le fichier [`scaffold.yml`](./scaffold_file_format.md) seront accessibles à tous les fichiers gabarits.
Afin de faciliter l'écriture des gabarits, `scaffold` intègre la librairie d'extension [`github.com/Masterminds/sprig`](http://masterminds.github.io/sprig/).
## Déclaration de variables et contraintes de validation
Voir le format du fichier [`scaffold.yml`](./scaffold_file_format.md).
> TODO

View File

@ -1,3 +0,0 @@
# Créer un nouveau modèle de projet
Un modèle de projet `scaffold` est un simple répertoire (ou dépôt Git) contenant à sa racine un fichier `scaffold.yml`.