README: section on cdm datasource configuration

diff --git a/README.md b/README.md
index ce2957ef96b5763bc6b5ceb14f58a4bf4d304937..0b636897affdde8d75cc161d1ba14ef731c5c225 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
-### Setup
+
+## Developer
+
+### Configure vaadin UIs for a specific cdm data source
+
+On the fist application startup on a cdm data source the `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration` will create a `vaadin-apps.properties` file in the cdm source specific configuration folder: `~/.cdmLibrary/remote-webapp/${cdm-source-bean-id}/`
+
+The default content of this file defined in `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration.APP_FILE_CONTENT` at the time of writing this documentation is :
+
+~~~
+################################################################
+#                                                               
+# Vaadin application specific configurations                    
+#                                                               
+################################################################
+                                                                
+# Enablement of vaadin uis.                                     
+#                                                               
+# Multiple uis can be defined as comma separated list.          
+# Whitespace before and after the comma will be ignored.        
+# Valid values are the path properties of the @SpringUI         
+# annotation which is used for UI classes.                      
+cdm-vaadin.ui.activated=account,concept,distribution,editstatus 
+~~~
+
+There are more UIs that can be activated by adding them to the `cdm-vaadin.ui.activated` property. 
+For example to enable the `RegistrationUI` you will need to add the name defined in `eu.etaxonomy.cdm.vaadin.ui.RegistrationUI.NAME`:
+
+~~~
+cdm-vaadin.ui.activated=account,concept,distribution,editstatus,registration 
+~~~
+
+
+#### Setup Selenium based UI tests 
+
 * Run a `clean install` goal to download the Selenium drivers