2022-04-30 21:19:50 +02:00
<!--
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.
-->
2022-05-05 16:47:09 +02:00
# Decidim for YunoHost
2022-04-30 21:19:50 +02:00
2022-05-05 16:47:09 +02:00
[![Integration level ](https://dash.yunohost.org/integration/decidim.svg )](https://dash.yunohost.org/appci/app/decidim) ![](https://ci-apps.yunohost.org/ci/badges/decidim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/decidim.maintain.svg)
[![Install Decidim with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=decidim)
2022-04-30 21:19:50 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-05-05 16:47:09 +02:00
> *This package allows you to install Decidim quickly and simply on a YunoHost server.
2022-04-30 21:19:50 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
## Overview
2022-05-05 16:47:09 +02:00
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.
2022-04-30 21:19:50 +02:00
2022-05-05 16:47:09 +02:00
### Features
2022-04-30 21:19:50 +02:00
2022-05-05 16:47:09 +02:00
- 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."
2022-04-30 21:19:50 +02:00
2022-05-05 16:47:03 +02:00
2022-05-05 16:47:09 +02:00
**Shipped version:** 0.26.1~ynh1
2022-05-05 16:47:03 +02:00
2022-05-05 16:47:09 +02:00
**Demo:** https://demo.example.com
2022-05-05 16:47:03 +02:00
2022-05-05 16:47:09 +02:00
## Screenshots
2022-05-05 16:47:03 +02:00
2022-05-05 16:47:09 +02:00
![](./doc/screenshots/example.jpg)
2022-04-30 21:19:50 +02:00
## 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://example.com
* Official user documentation: https://yunohost.org/apps
* Official admin documentation: https://yunohost.org/packaging_apps
2022-04-30 21:19:52 +02:00
* Upstream app code repository: https://some.forge.com/example/example
2022-05-05 16:47:09 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_decidim
* Report a bug: https://github.com/YunoHost-Apps/decidim_ynh/issues
2022-04-30 21:19:50 +02:00
## Developer info
2022-05-05 16:47:09 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/decidim_ynh/tree/testing ).
2022-04-30 21:19:50 +02:00
To try the testing branch, please proceed like that.
```
2022-05-05 16:47:09 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/decidim_ynh/tree/testing --debug
2022-04-30 21:19:50 +02:00
or
2022-05-05 16:47:09 +02:00
sudo yunohost app upgrade decidim -u https://github.com/YunoHost-Apps/decidim_ynh/tree/testing --debug
2022-04-30 21:19:50 +02:00
```
2022-05-05 16:47:09 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps