Issue 10495

Create README files for our projects

10495
Reporter: lfrancke
Type: Improvement
Summary: Create README files for our projects
Priority: Major
Resolution: Fixed
Status: Closed
Created: 2011-12-09 16:03:08.327
Updated: 2013-12-09 14:01:24.574
Resolved: 2012-06-19 12:05:24.548
        
Description: Our projects have become pretty complex and they depend on each other. It is not immediately visible what kind of profiles and properties they need.

We should document the following in each README file:
* Name of the project and short description, what is the checklistbank-autocomplete project? I don't know.
* Document the status if it's not in production (experiment, not working, deprecated etc.)
* Which properties does the project need to build (for example DB connection parameters for Integration Tests or deployment)
* Document the usage of DBs (read only/read-write) etc.
* Any other special things to mention (special DB requirements, e.g. "this project requires plpgsql enabled for its database) ]]>