Update DESCRIPTION.md

2024-09-03 18:16:27 +02:00 · 2023-01-04 10:52:52 +01:00 · 2023-01-04 10:52:52 +01:00 · 4d542caf7f
commit 4d542caf7f
parent b041ec5032
1 changed files with 72 additions and 6 deletions
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@ -1,9 +1,75 @@
-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.
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
+# Cultivons for YunoHost
+
+[![Integration level](https://dash.yunohost.org/integration/cultivons.svg)](https://dash.yunohost.org/appci/app/cultivons) ![Working status](https://ci-apps.yunohost.org/ci/badges/cultivons.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/cultivons.maintain.svg)  
+[![Install cultivons with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cultivons)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install cultivons 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
+
+__Cultivons!__ is a software in the form of an internal site aiming at helping the management of a BAD (Sustainable Autonomous Base).
+
+An BAD is a place where one or more people can (over)live a disaster (natural, plague, war, economic collapse ... put here the reason that pleases you or scares you the most), for a more or less long period of time, without needing the outside: supermarkets, hospitals, and other services present in a modern society.
+
+This definition is a little broad, in fact a BAD will often materialize by a place in the countryside where one will try to be as autonomous as possible on the most important aspects of survival:
+
+* food (vegetable garden, orchard, animals ... everything that is culture and breeding) ;
+* electricity ;
+* water (including potabilization) ;
+* heating ;
+* first aid ;
+* storage of recipes, guides and other documentation ;
+* ...
+
+With __cultivons!__, you can manage 
+- your crops, your garden and the associated tasks (semi, harvest) as well as garden plan.
+- the weather,
+- the stocks,
+- your documents,
+- your budget (Bank Account).

 ### Features
+- x 
+- x

- 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:** 1.6
+
+**Demo:** https://cultivons-demo.xulops.net
+
+## Screenshots
+
+![Screenshot of cultivons](./doc/screenshots/cultivonsfull.png)
+
+## Documentation and resources
+
+* Official app website: <https://xulops.net/forge/cultivons.php>
+* Official admin documentation: <https://xulops.net/forge/cultivons.php>
+* Upstream app code repository: <https://xulops.net/forge/cultivons.php?menu=download>
+* YunoHost documentation for this app: <https://yunohost.org/app_cultivons>
+* Report a bug: <https://github.com/YunoHost-Apps/cultivons_ynh/issues>
+
+## Articles
+
+* linuxfr <https://linuxfr.org/users/xulops/journaux/cultivons-logiciel-de-gestion-de-bad>
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade cultivons -u https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>