generate:module - Add README

src/CRM/CivixBundle/Command/InitCommand.php

@@ -1,6 +1,8 @@
 <?php
 namespace CRM\CivixBundle\Command;
 
+use CRM\CivixBundle\Builder\CopyFile;
+use CRM\CivixBundle\Builder\Template;
 use CRM\CivixBundle\Services;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\InputArgument;
@@ -88,11 +90,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
       $basedir->string('build'),
       $basedir->string('templates'),
       $basedir->string('xml'),
+      $basedir->string('images'),
       $basedir->string($ctx['namespace']),
     ));
     $ext->builders['info'] = new Info($basedir->string('info.xml'));
     $ext->builders['module'] = new Module(Services::templating());
     $ext->builders['license'] = new License($licenses->get($ctx['license']), $basedir->string('LICENSE.txt'), FALSE);
+    $ext->builders['readme'] = new Template('readme.md.php', $basedir->string('README.md'), FALSE, Services::templating());
+    $ext->builders['screenshot'] = new CopyFile(dirname(dirname(dirname(dirname(__DIR__)))) . '/images/placeholder.png', $basedir->string('images/screenshot.png'), FALSE);
 
     $ext->loadInit($ctx);
     $ext->save($ctx, $output);

src/CRM/CivixBundle/Resources/views/Code/readme.md.php

@@ -0,0 +1,45 @@
+# <?php echo $fullName; ?>
+
+
+![Screenshot](/images/screenshot.png)
+
+(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
+
+The extension is licensed under [<?php echo $license ?>](LICENSE.txt).
+
+## Requirements
+
+* PHP v5.4+
+* CiviCRM (*FIXME: Version number*)
+
+## Installation (Web UI)
+
+This extension has not yet been published for installation via the web UI.
+
+## Installation (CLI, Zip)
+
+Sysadmins and developers may download the `.zip` file for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+cd <extension-dir>
+cv dl <?php echo $fullName; ?>@https://github.com/FIXME/<?php echo $fullName; ?>/archive/master.zip
+```
+
+## Installation (CLI, Git)
+
+Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+git clone https://github.com/FIXME/<?php echo $fullName; ?>.git
+cv en <?php echo $mainFile . "\n"; ?>
+```
+
+## Usage
+
+(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
+
+## Known Issues
+
+(* FIXME *)