diff --git a/README.md b/README.md index 2c3a67b..49318bd 100644 --- a/README.md +++ b/README.md @@ -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