diff --git a/README.md b/README.md index 61cda90..169b10d 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,52 @@ -# Redmine app for YunoHost + -**Shipped version:** 4.0.4 +# Redmine for YunoHost -- [Yunohost project](https://yunohost.org) -- [Redmine website](https://www.redmine.org/) +[![Integration level](https://dash.yunohost.org/integration/redmine.svg)](https://dash.yunohost.org/appci/app/redmine) ![](https://ci-apps.yunohost.org/ci/badges/redmine.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/redmine.maintain.svg) +[![Install Redmine with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=redmine) -![](https://dudodiprj2sv7.cloudfront.net/product-logos/ck/rN/L1BJGTE8HK3O-180x180.PNG) +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Redmine 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 + +Redmine is a flexible project management web application written using Ruby on Rails framework. -[![Install Redmine with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=redmine) +**Shipped version:** 4.2.4~ynh1 -### Installing guide - App can be installed by YunoHost **admin web-interface** or by **running following command**: - $ sudo yunohost app install https://github.com/YunoHost-Apps/redmine_ynh - - After Install - - 1. Login in redmine with admin / admin +## Disclaimers / important information - -### Upgrade this package: +Use default administrator account to log in: - $ sudo yunohost app upgrade redmine -u https://github.com/YunoHost-Apps/redmine_ynh +- login: admin +- password: admin + +You can go to Administration menu and choose Settings to modify most of the application settings. + +## Documentation and resources + +* Official app website: https://www.redmine.org +* Upstream app code repository: https://github.com/redmine/redmine +* YunoHost documentation for this app: https://yunohost.org/app_redmine +* Report a bug: https://github.com/YunoHost-Apps/redmine_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/redmine_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/redmine_ynh/tree/testing --debug +or +sudo yunohost app upgrade redmine -u https://github.com/YunoHost-Apps/redmine_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..91e7050 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,48 @@ +# Redmine pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/redmine.svg)](https://dash.yunohost.org/appci/app/redmine) ![](https://ci-apps.yunohost.org/ci/badges/redmine.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/redmine.maintain.svg) +[![Installer Redmine avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=redmine) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Redmine 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 + +Redmine is a flexible project management web application written using Ruby on Rails framework. + + +**Version incluse :** 4.2.4~ynh1 + + + +## Avertissements / informations importantes + +Use default administrator account to log in: + +- login: admin +- password: admin + +You can go to Administration menu and choose Settings to modify most of the application settings. + +## Documentations et ressources + +* Site officiel de l'app : https://www.redmine.org +* Dépôt de code officiel de l'app : https://github.com/redmine/redmine +* Documentation YunoHost pour cette app : https://yunohost.org/app_redmine +* Signaler un bug : https://github.com/YunoHost-Apps/redmine_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/redmine_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/redmine_ynh/tree/testing --debug +ou +sudo yunohost app upgrade redmine -u https://github.com/YunoHost-Apps/redmine_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file