From 4176f463227703561bfbfd7e48780cd91205c063 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Mon, 23 Feb 2015 01:20:16 +0100
Subject: [PATCH] Readme

---
 README.md | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1d7e21f..7a21805 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,42 @@ git clone https://github.com/simmstein/pdns-console.git
 cd pdns-console
 ```
 
-### Configure database access
+### Dependances
 
-In propel.yaml:
+```
+curl -sS https://getcomposer.org/installer | php
+./composer.phar install
+```
+
+### Database
+
+#### Edit *propel.yaml*
 
 * ```dsn: "mysql:host=localhost;dbname=pdns"```
   * Change *localhost* by the database server name
   * Change "pdns" by the database name
 
 * Change user and password values with you pdsn database login
+
+Run `./app/propel/console config:convert`
+
+#### Models
+
+The sources does not contain all application models. You have to generate them:
+
+Run `./app/propel/console --recursive model:build`
+
+#### Database updates
+
+pdns-console needs to update pdns original tables and uses 3 mores.
+
+```shell
+./app/propel/console --recursive migration:diff
+./app/propel/console --recursive migration:migrate
+```
+
+## Symlink
+
+To access the console without use the full path of `app/console`, make a symlink:
+
+```ln -s $PWD/app/console /usr/local/bin/```