From: Silvio Rhatto <rhatto@riseup.net>
Date: Fri, 10 Nov 2017 01:25:37 +0000 (-0200)
Subject: README: example: basic project
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=fa180f34165246e66ea24f2f9e8b99023f95231d;p=templater.git

README: example: basic project
---

diff --git a/README.md b/README.md
index 33560f5..d7b3b75 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,16 @@ You can also verify the latest commit's OpenPGP signature:
 Note that `/usr/bin/git` is called to avoid any other `git` wrappers or aliases
 you might have available on your shell.
 
-## Example: Drupal 8 Development
+## Examples
+
+### Basic project
+
+Say you want to start a new project `myproject` at `$HOME/src/myproject`, using git, basic
+files an a GPLv3 license:
+
+    templater $HOME/src/myproject basic gpl git
+
+### Drupal 8 Development
 
 Create the project (requires [KVMX](https://kvmx.fluxo.info)):
 
@@ -47,7 +56,7 @@ Install the drupal instance:
     echo '( cd /srv/kvmx && make drush        )' | kvmx ssh
     echo '( cd /srv/kvmx && make site_install )' | kvmx ssh
 
-### Writing modules
+## Writing modules
 
 Modules can be written using any programming language. It will be called from the project
 toplevel folder with templater's `share` folder as the first parameter.