first draft

README.md

@@ -0,0 +1,67 @@
+# Kimai - Time Tracking Application
+
+Kimai si base on Symfony framework and floowing its best practices.
+
+[![Build Status](https://travis-ci.org/kevinpapst/kimai2.svg?branch=master)](https://travis-ci.org/kevinpapst/kimai2)
+
+Requirements
+------------
+
+  * PHP 5.5.9 or higher;
+  * One PHP extension of PDO-SQLite and/or PDO-MySQL enabled;
+  * and the [usual Symfony application requirements](http://symfony.com/doc/current/reference/requirements.html).
+
+If unsure about meeting these requirements, download the demo application and
+browse the `http://localhost:8000/config.php` script to get more detailed
+information.
+
+Installation
+------------
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
+
+First, install the [Symfony Installer](https://github.com/symfony/symfony-installer)
+if you haven't already. Then, install the Symfony Demo Application executing
+this command anywhere in your system:
+
+```bash
+$ symfony demo
+
+# if you're using Windows:
+$ php symfony demo
+```
+
+If the `demo` command is not available, update your Symfony Installer to the
+most recent version executing the `symfony self-update` command.
+
+> **NOTE**
+>
+> If you can't use the Symfony Installer, download and install the demo
+> application using Git and Composer:
+>
+>     $ git clone https://github.com/symfony/symfony-demo
+>     $ cd symfony-demo/
+>     $ composer install --no-interaction
+
+Usage
+-----
+
+There is no need to configure a virtual host in your web server to access the application.
+Just use the built-in web server:
+
+```bash
+$ cd symfony-demo/
+$ php bin/console server:run
+```
+
+This command will start a web server for the Symfony application. Now you can
+access the application in your browser at <http://localhost:8000>. You can
+stop the built-in web server by pressing `Ctrl + C` while you're in the
+terminal.
+
+> **NOTE**
+>
+> If you want to use a fully-featured web server (like Nginx or Apache) to run
+> Symfony Demo application, configure it to point at the `web/` directory of the project.
+> For more details, see:
+> http://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html