diff --git a/README.md b/README.md index 16d3dd0..ad6f400 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@ -Apache-OFBiz 13.07.01 for Yunohost + -This version don't use SSO and OpenLDAP so you need to connect with admin(pswd:ofbiz). +# OFBiz for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/ofbiz.svg)](https://dash.yunohost.org/appci/app/ofbiz) ![](https://ci-apps.yunohost.org/ci/badges/ofbiz.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ofbiz.maintain.svg) +[![Install OFBiz with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ofbiz) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install OFBiz 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 + +Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +### Features + +- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; +- Laboris nisi ut aliquip ex ea commodo consequat ; +- Duis aute irure dolor in reprehenderit in voluptate ; +- Velit esse cillum dolore eu fugiat nulla pariatur ; +- Excepteur sint occaecat cupidatat non proident, sunt in culpa." + + +**Shipped version:** 18.12.05~ynh1 + + + +## Disclaimers / important information + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * requiring a full dedicated domain ? + * architectures not supported ? + * not-working single-sign on or LDAP integration ? + * the app requires an important amount of RAM / disk / .. to install or to work properly + * etc... + +* Other infos that people should be aware of, such as: + * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) + * how to configure / administrate the application if it ain't obvious + * upgrade process / specificities / things to be aware of ? + * security considerations ? + +## Documentation and resources + +* Official app website: https://ofbiz.apache.org +* Official user documentation: https://cwiki.apache.org/confluence/display/OFBIZ/Documentation +* Upstream app code repository: https://github.com/apache/ofbiz-framework +* YunoHost documentation for this app: https://yunohost.org/app_ofbiz +* Report a bug: https://github.com/YunoHost-Apps/ofbiz_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ofbiz_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/ofbiz_ynh/tree/testing --debug +or +sudo yunohost app upgrade ofbiz -u https://github.com/YunoHost-Apps/ofbiz_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 index c89de4d..fb483b6 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,12 +1,12 @@ -# Example app pour YunoHost +# OFBiz pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](https://dash.yunohost.org/integration/ofbiz.svg)](https://dash.yunohost.org/appci/app/ofbiz) ![](https://ci-apps.yunohost.org/ci/badges/ofbiz.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ofbiz.maintain.svg) +[![Installer OFBiz avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ofbiz) *[Read this readme in english.](./README.md)* *[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer OFBiz 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 @@ -22,13 +22,9 @@ Some long and extensive description of what the app is and does, lorem ipsum dol - Excepteur sint occaecat cupidatat non proident, sunt in culpa." -**Version incluse :** 1.0~ynh1 +**Version incluse :** 18.12.05~ynh1 -**Démo :** https://demo.example.com -## Captures d'écran - -![](./doc/screenshots/example.jpg) ## Avertissements / informations importantes @@ -47,22 +43,21 @@ Some long and extensive description of what the app is and does, lorem ipsum dol ## Documentations et ressources -* Site officiel de l'app : https://example.com -* Documentation officielle utilisateur : https://yunohost.org/apps -* Documentation officielle de l'admin : https://yunohost.org/packaging_apps -* Dépôt de code officiel de l'app : https://some.forge.com/example/example -* Documentation YunoHost pour cette app : https://yunohost.org/app_example -* Signaler un bug : https://github.com/YunoHost-Apps/example_ynh/issues +* Site officiel de l'app : https://ofbiz.apache.org +* Documentation officielle utilisateur : https://cwiki.apache.org/confluence/display/OFBIZ/Documentation +* Dépôt de code officiel de l'app : https://github.com/apache/ofbiz-framework +* Documentation YunoHost pour cette app : https://yunohost.org/app_ofbiz +* Signaler un bug : https://github.com/YunoHost-Apps/ofbiz_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ofbiz_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/ofbiz_ynh/tree/testing --debug ou -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade ofbiz -u https://github.com/YunoHost-Apps/ofbiz_ynh/tree/testing --debug ``` **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file