From 4608b7abd7ca0bd6c641a4facc25c6f55487f4b6 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Mon, 27 Sep 2021 12:26:48 +0000 Subject: [PATCH] Auto-update README --- README.md | 67 ++++++++++++++-------------------------------------- README_fr.md | 36 ++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 49 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 78d1b93..816b04d 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,32 @@ -# Kimai2 app for YunoHost + + +# Kimai2 for YunoHost [![Integration level](https://dash.yunohost.org/integration/kimai2.svg)](https://dash.yunohost.org/appci/app/kimai2) ![](https://ci-apps.yunohost.org/ci/badges/kimai2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kimai2.maintain.svg) -[![Install Kimai2 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=kimai2) +[![Install Kimai2 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kimai2) -> *This package allows you to install kimai2 quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Kimai2 quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now. -Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE). -https://github.com/kevinpapst/kimai2 +Multi-user application for time-tracking with support for mobile devices -Shipped Version: **1.11.1** +**Shipped version:** 1.15.2~ynh1 -## Screenshots -![](https://www.kimai.org/images/screenshots/time-tracking.png) -## Demo +## Documentation and resources -* [Official demo](https://www.kimai.org/demo/) +* YunoHost documentation for this app: https://yunohost.org/app_kimai2 +* Report a bug: https://github.com/YunoHost-Apps/kimai2_ynh/issues -### Guidelines - - 1. Require dedicated domain like **kimai.domain.tld**. - 1. This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server) - -## Documentation - - * Official documentation: https://www.kimai.org/documentation - -## YunoHost specific features - -#### Multi-user support - -LDAP is supported -HTTP auth is not supported -Defaul Kimai2 roles are: -* ROLE_USER -* ROLE_TEAMLEAD => Kimai2 (Teamlead) YunoHost permission -* ROLE_ADMIN => Kimai2 (Admin) YunoHost permission -* ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission -Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kimai2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kimai2/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kimai2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kimai2/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/kimai2_ynh/issues - * App website: https://www.kimai.org/ - * Upstream app repository: https://github.com/kevinpapst/kimai2 - * YunoHost website: https://yunohost.org/ - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing). @@ -69,3 +36,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kimai2_ynh/tree/testi or sudo yunohost app upgrade kimai2 -u https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..2f7488e --- /dev/null +++ b/README_fr.md @@ -0,0 +1,36 @@ +# Kimai2 pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/kimai2.svg)](https://dash.yunohost.org/appci/app/kimai2) ![](https://ci-apps.yunohost.org/ci/badges/kimai2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kimai2.maintain.svg) +[![Installer Kimai2 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kimai2) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Kimai2 rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Application web de suivi du temps, multi-utilisateurs, et compatible avec les appareils mobiles + +**Version incluse :** 1.15.2~ynh1 + + + +## Documentations et ressources + +* Documentation YunoHost pour cette app : https://yunohost.org/app_kimai2 +* Signaler un bug : https://github.com/YunoHost-Apps/kimai2_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug +ou +sudo yunohost app upgrade kimai2 -u https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file