#knife-cookbook-readme

{{INLINETOC}}

Ceci est un plugin Knife pour générer un fichier README.md squelette à partir du fichier metadata.rb d'un livre de recettes.

  * créer les premiers morceaux de documentation sur lesquels vous pouvez construire
  * écrire une documentation cohérente entre vos livres de cuisine ou ceux de votre équipe
  * implémenter la règle DRY / SPOT (metadata.rb est la source d'information faisant autorité)

##Installation

Vous pouvez installer le plugin via RubyGems:

$ gem install knife-cookbook-readme

##Options

    -c, --constraints Inclure les contraintes de version pour les plates-formes et les dépendances
    -t, --template FILE Définit le fichier de modèle utilisé pour rendre README.md

##Exemples

    knife cookbook readme from path/to/metadata.rb
    knife cookbook readme from path/to/metadata.rb --constraints >README.md
    knife cookbook readme from path/to/metadata.rb --template README.md.erb

Notez que la commande écrira la sortie générée à STDOUT. Il suffit de rediriger la sortie vers README.md pour écrire dans un fichier.