mirror of
https://github.com/YunoHost-Apps/ergo_ynh.git
synced 2024-09-03 18:26:31 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
f7328ca0da
commit
b9011b77c5
2 changed files with 54 additions and 64 deletions
62
README.md
62
README.md
|
|
@ -1,48 +1,38 @@
|
|||
|
||||
# Packaging an app, starting from this example
|
||||
|
||||
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
- Edit the `manifest.json` 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.](https://yunohost.org/packaging_apps_helpers)
|
||||
- Add a `LICENSE` file for the package.
|
||||
- Edit `doc/DISCLAIMER*.md`
|
||||
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Ergo for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/ergo)  
|
||||
[](https://install-app.yunohost.org/?app=ergo)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install example quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Ergo 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
|
||||
|
||||
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
|
||||
Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design
|
||||
|
||||
**Shipped version:** 1.0~ynh1
|
||||
### Features
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
- Being simple to set up and use
|
||||
- Combining the features of an ircd, a services framework, and a bouncer (integrated account management, history storage, and bouncer functionality)
|
||||
- Bleeding-edge IRCv3 support, suitable for use as an IRCv3 reference implementation
|
||||
- High customizability via a rehashable (i.e., reloadable at runtime) YAML config
|
||||
|
||||
|
||||
|
||||
**Shipped version:** 2.9.1~ynh1
|
||||
|
||||
**Demo:** https://testnet.ergo.chat/
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
|
|
@ -59,26 +49,24 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
|
|||
* 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
|
||||
* Upstream app code repository: https://some.forge.com/example/example
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_example
|
||||
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
||||
* Official app website: https://ergo.chat/
|
||||
* Official user documentation: https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md
|
||||
* Official admin documentation: https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md
|
||||
* Upstream app code repository: https://github.com/ergochat/ergo
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_ergo
|
||||
* Report a bug: https://github.com/YunoHost-Apps/ergo_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ergo_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade ergo -u https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
54
README_fr.md
54
README_fr.md
|
|
@ -1,30 +1,34 @@
|
|||
# Example app pour YunoHost
|
||||
# Ergo pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/ergo)  
|
||||
[](https://install-app.yunohost.org/?app=ergo)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install example 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.*
|
||||
> *Ce package vous permet d'installer Ergo rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
|
||||
Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design
|
||||
|
||||
**Version incluse:** 1.0~ynh1
|
||||
### Features
|
||||
|
||||
**Démo:** https://demo.example.com
|
||||
- Being simple to set up and use
|
||||
- Combining the features of an ircd, a services framework, and a bouncer (integrated account management, history storage, and bouncer functionality)
|
||||
- Bleeding-edge IRCv3 support, suitable for use as an IRCv3 reference implementation
|
||||
- High customizability via a rehashable (i.e., reloadable at runtime) YAML config
|
||||
|
||||
|
||||
|
||||
**Version incluse :** 2.9.1~ynh1
|
||||
|
||||
**Démo :** https://testnet.ergo.chat/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
|
|
@ -41,26 +45,24 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
|
|||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site official de l'app : https://example.com
|
||||
* Documentation officielle utilisateur: https://yunohost.org/apps
|
||||
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
|
||||
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
||||
* Site officiel de l'app : https://ergo.chat/
|
||||
* Documentation officielle utilisateur : https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md
|
||||
* Documentation officielle de l'admin : https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md
|
||||
* Dépôt de code officiel de l'app : https://github.com/ergochat/ergo
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_ergo
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/ergo_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ergo_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
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
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade ergo -u https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Reference in a new issue