# HG changeset patch
# User nowmad@23.1.168.192.in-addr.arpa
# Date 1447672530 -3600
# Node ID e0613cc29a30bee89458e41b92c738a732fb06d3
# Parent  acbf8f17be9a525cae6510b5b22ce183f109feb7
update client README

diff -r acbf8f17be9a -r e0613cc29a30 client/README.md
--- a/client/README.md	Fri Oct 16 12:38:47 2015 +0200
+++ b/client/README.md	Mon Nov 16 12:15:30 2015 +0100
@@ -1,14 +1,37 @@
 Ammico client webapp
 ====================
 
-Dev:
+This README describes the Ammico client which is a tool to consult and manage museum's visits.
+
+Structure:
+---
+
+The application is developed with Angular.
+- app/ : this folder contains the main javascript files of the application
+- img/ : contains the assets needed by the app
+- data/ : (optional) here goes the test file to simulate an interaction with the server if needed
+- build/ : folder created when the app is built by gulp. Contains all the app js, styles and assets.
+
+Installation:
 ---
 
 - `npm install`
-- `node_modules/.bin/gulp`
-- `node_modules/.bin/bower install -D <some-packages>`
+- `node_modules/.bin/bower install`
+
+Building the app:
+---
+
+We use gulp in order to generate the app. To build it you can run the following command line:
+- `./node_modules/.bin/gulp` or simply `gulp` if it is globally installed in your system
 
-TODO:
------
+Then to copy the files to the server part you can use:
+- `./node_modules/.bin/gulp copy-server` or simply `gulp copy-server`
 
-- unit tests
+Entry points:
+---
+There are few entry points to configure the client. It can be define in the gulpfile or the generated index.html
+
+idExpo: 'idExpo: "{{ context.idExpo }}",',
+ammicoUrl: 'ammicoUrl: "{{ context.ammicoUrl }}",',
+searchUrl: 'searchUrl: "{{ context.searchUrl }}",',
+token: '{% if context.token %} token: "{{ context.token }}", {% endif %}'