diff --git a/README.md b/README.md index 49318bd..a998707 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/create_project_template.md b/doc/create_project_template.md new file mode 100644 index 0000000..fadd8e5 --- /dev/null +++ b/doc/create_project_template.md @@ -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 \ No newline at end of file diff --git a/doc/create_projet_template.md b/doc/create_projet_template.md deleted file mode 100644 index 41b216a..0000000 --- a/doc/create_projet_template.md +++ /dev/null @@ -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`.