Packaging an app, starting from this example

• Copy this app before working on it, using the 'Use this template' button on the Github repo
• Edit the manifest.toml with app specific info
• Edit the install, upgrade, remove, backup and restore scripts, and any relevant conf files in conf/
  • Using the script helpers documentation
• Edit the change_url and config scripts too, or remove them if you have no use of them
• Add a LICENSE file for the package.
  • NB: this LICENSE file is not meant to necessarily be the same LICENSE as the upstream app - it is only the LICENSE you want this package's code to published with and you can choose it freely! (If you don't know which to choose, we recommend the AGPL-3)
• Edit files under the doc/ directory (see the page about documenting packages)
• The README.md files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator

---

Example app for YunoHost

Read this README in other languages.

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.

Overview

This is a dummy description of this app features

Shipped version: 1.0~ynh1

Demo: https://demo.example.com

Screenshots

Documentation and resources

• Official app website: https://example.com
• Official user documentation: https://yunohost.org/apps
• Official admin documentation: https://yunohost.org/packaging_apps
• Upstream app code repository: https://some.forge.com/example/example
• YunoHost Store: https://apps.yunohost.org/app/example
• Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues

Developer info

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