diff --git a/README.md b/README.md index f3731668..d21e4bc5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kimai - Time Tracking Application -Kimai si base on Symfony framework and floowing its best practices. +Kimai v2 - the reloaded open source Time-Tracking application, based on Symfony and powered by PHP. [![Build Status](https://travis-ci.org/kevinpapst/kimai2.svg?branch=master)](https://travis-ci.org/kevinpapst/kimai2) @@ -20,29 +20,15 @@ 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: +First, install Git and [Composer](https://getcomposer.org/doc/00-intro.md) +if you haven't already. Then, clone this repo and execute this command in the cloned directory: ```bash -$ symfony demo - -# if you're using Windows: -$ php symfony demo +$ git clone https://github.com/kevinpapst/kimai2.git +$ cd kimai2/ +$ composer install ``` -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 ----- @@ -50,11 +36,10 @@ There is no need to configure a virtual host in your web server to access the ap 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 +This command will start a web server for Kimai. Now you can access the application in your browser at . You can stop the built-in web server by pressing `Ctrl + C` while you're in the terminal. @@ -62,6 +47,6 @@ 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. +> Kimai, 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