jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Kevin Papst
2016-10-20 22:39:22 +02:00
parent bb12217d4a
commit b118987f5e
1 changed files with 8 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,6 +1,6 @@
# Kimai - Time Tracking Application # 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) [![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) [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
First, install the [Symfony Installer](https://github.com/symfony/symfony-installer) First, install Git and [Composer](https://getcomposer.org/doc/00-intro.md)
if you haven't already. Then, install the Symfony Demo Application executing if you haven't already. Then, clone this repo and execute this command in the cloned directory:
this command anywhere in your system:
```bash ```bash
$ symfony demo $ git clone https://github.com/kevinpapst/kimai2.git
$ cd kimai2/
# if you're using Windows: $ composer install
$ 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 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: Just use the built-in web server:
```bash ```bash
$ cd symfony-demo/
$ php bin/console server:run $ 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 <http://localhost:8000>. 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 stop the built-in web server by pressing `Ctrl + C` while you're in the
terminal. terminal.
@@ -62,6 +47,6 @@ terminal.
> **NOTE** > **NOTE**
> >
> If you want to use a fully-featured web server (like Nginx or Apache) to run > 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: > For more details, see:
> http://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html > http://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html