YunoHost-Apps/cultivons_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/cultivons_ynh.git synced 2024-09-03 18:16:27 +02:00
Code Issues Activity Actions

Update README.md

Browse source
This commit is contained in:
plabuse 2023-01-04 10:06:38 +01:00 committed by GitHub
parent c407e3ed33
commit e24bec074f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -3,59 +3,63 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand.
-->
# Cultivons for YunoHost
# 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)
[![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.
> *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
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.
__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.0~ynh1
**Shipped version:** 1.6
**Demo:** https://cultivons-demo.xulops.net
## Screenshots
![Screenshot of Cultivons](./doc/screenshots/cultivonsfull.png)
![Screenshot of Cultivons](./doc/screenshots/example.jpg)
## 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 ?
![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).