Mise à jour de 'README.md'

This commit is contained in:
wpetit 2020-05-23 12:14:58 +02:00
parent a09cf49a61
commit d01858a6ad
1 changed files with 9 additions and 1 deletions

View File

@ -1,6 +1,14 @@
# Scaffold
Utilitaire de génération d'arborescence de fichiers à partir de projets "modèles" distants/locaux.
## Description
`scaffold` est un outil permettant de générer une arborescence de fichiers à partir d'un modèle pré-existant.
Ce modèle peut être soit un répertoire local soit un dépôt Git distant.
De plus, `scaffold` intègre un mécanisme de templating permettant d'injecter des données dynamiques dans les fichiers à copier. Par défaut, tout fichier dont l'extension est `.gotpl` sera soumis à ce templating.
Un fichier "manifeste" (par défaut `scaffold.yml`) peut être créé afin de déclarer les variables à injecter. Ces variables seront demandées à l'utilisateur lors du lancement de la commande `scaffold from`.
## Installation