diff --git a/README.md b/README.md index 99d944b..11563bf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ -LibreERP ----- -[![Integration level](https://dash.yunohost.org/integration/libreerp.svg)](https://dash.yunohost.org/appci/app/libreerp) -[![Install libreerp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=libreerp) + + +# LibreERP for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/libreerp.svg)](https://dash.yunohost.org/appci/app/libreerp) ![](https://ci-apps.yunohost.org/ci/badges/libreerp.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/libreerp.maintain.svg) +[![Install LibreERP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreerp) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install LibreERP 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 LibreERP is a suite of web based open source business apps. LibreERP is a fork of Odoo Community Edition. @@ -9,8 +21,13 @@ The main LibreERP Apps include an Open Source CRM, Website Builder, eCommerce, P LibreERP Apps can be used as stand-alone applications, but they also integrate seamlessly so you get a full-featured Open Source ERP when you install several Apps. -LibreERP for YunoHost ----------------------------- + +**Shipped version:** 12.0-6 + +**Demo:** https://www.odoo.com/trial + +## Disclaimers / important information + **WARNING**: LibreERP is a complex app. **DO NOT USE THIS PACKAGE** to run your business unless you know what you are doing!!! If you don't, you should consider to ask for help from a professionnal! **IMPORTANT:** This app MUST be installed on a domain's root! @@ -20,14 +37,32 @@ https://example.com/erp/ will NOT work To connect on your LibreERP ----------- - Go on https://YOURDOMAIN/web -- Use your master password OR admin/admin if you use LibreERP 8.0 - -Contribute ------------ -See the project here : https://github.com/YunoHost-Apps/libreerp_ynh/projects/1 +- Use your master password About licences ----------- LibreERP 8.0 is under AGPL-3.0 Next version are under LGPL-3.0 LibreERP is forked from Odoo Community Edition. The name is change due to Odoo trademark policy. + +## Documentation and resources + +* Official app website: https://odoo.com +* Official user documentation: https://www.odoo.com/documentation/15.0/applications.html +* Official admin documentation: https://www.odoo.com/documentation/15.0/administration.html +* Upstream app code repository: https://github.com/odoo/odoo +* YunoHost documentation for this app: https://yunohost.org/app_libreerp +* Report a bug: https://github.com/YunoHost-Apps/libreerp_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/libreerp_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/libreerp_ynh/tree/testing --debug +or +sudo yunohost app upgrade libreerp -u https://github.com/YunoHost-Apps/libreerp_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..89be0e5 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,64 @@ +# LibreERP pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/libreerp.svg)](https://dash.yunohost.org/appci/app/libreerp) ![](https://ci-apps.yunohost.org/ci/badges/libreerp.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/libreerp.maintain.svg) +[![Installer LibreERP avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreerp) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer LibreERP 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 + +LibreERP is a suite of web based open source business apps. LibreERP is a fork of Odoo Community Edition. + +The main LibreERP Apps include an Open Source CRM, Website Builder, eCommerce, Project Management, Billing & Accounting, Point of Sale, Human Resources, Marketing, Manufacturing, Purchase Management, ... + +LibreERP Apps can be used as stand-alone applications, but they also integrate seamlessly so you get a full-featured Open Source ERP when you install several Apps. + + +**Version incluse :** 12.0-6 + +**Démo :** https://www.odoo.com/trial + +## Avertissements / informations importantes + +**WARNING**: LibreERP is a complex app. **DO NOT USE THIS PACKAGE** to run your business unless you know what you are doing!!! If you don't, you should consider to ask for help from a professionnal! + +**IMPORTANT:** This app MUST be installed on a domain's root! +https://erp.example.com/ will work +https://example.com/erp/ will NOT work + +To connect on your LibreERP +----------- +- Go on https://YOURDOMAIN/web +- Use your master password + +About licences +----------- +LibreERP 8.0 is under AGPL-3.0 +Next version are under LGPL-3.0 +LibreERP is forked from Odoo Community Edition. The name is change due to Odoo trademark policy. + +## Documentations et ressources + +* Site officiel de l'app : https://odoo.com +* Documentation officielle utilisateur : https://www.odoo.com/documentation/15.0/applications.html +* Documentation officielle de l'admin : https://www.odoo.com/documentation/15.0/administration.html +* Dépôt de code officiel de l'app : https://github.com/odoo/odoo +* Documentation YunoHost pour cette app : https://yunohost.org/app_libreerp +* Signaler un bug : https://github.com/YunoHost-Apps/libreerp_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/libreerp_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/libreerp_ynh/tree/testing --debug +ou +sudo yunohost app upgrade libreerp -u https://github.com/YunoHost-Apps/libreerp_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file