Example package for YunoHost applications.
manifest.toml
with app specific info.install
, upgrade
, remove
, backup
and restore
scripts, and any relevant conf files in conf/
.
change_url
and config
scripts too, or remove them if you have no use of themLICENSE
file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use the AGPL-3.doc/
directoryREADME.md
files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
This package allows you to install Example app quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
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.
Shipped version: 1.0~ynh1
Demo: https://demo.example.com
Any known limitations, constrains or stuff not working, such as (but not limited to):
Other infos that people should be aware of, such as:
Please send your pull request to the testing branch.
To try the testing branch, please proceed like that.
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
More info regarding app packaging: https://yunohost.org/packaging_apps