mirror of
https://github.com/YunoHost-Apps/firefish_ynh.git
synced 2024-09-03 18:36:06 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
6feab7de85
commit
8f18106439
2 changed files with 40 additions and 45 deletions
49
README.md
49
README.md
|
|
@ -1,62 +1,55 @@
|
|||
# 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
|
||||
# Firefish for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://dash.yunohost.org/appci/app/firefish)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://install-app.yunohost.org/?app=firefish)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Firefish 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
|
||||
|
||||
This is a dummy description of this app features
|
||||
|
||||
A greatly enhanced fork of Misskey with better UI/UX, security, features, and more! https://joinfirefish.org/
|
||||
|
||||
|
||||
**Shipped version:** 1.0~ynh1
|
||||
Firefish is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web UI, rich chatting, and much more!
|
||||
Firefish adds many quality of life changes and bug fixes for users and instance admins alike.
|
||||
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
|
||||
**Shipped version:** 1.0.3~ynh1
|
||||
|
||||
**Demo:** https://joinfirefish.org/
|
||||
|
||||
## 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 documentation for this app: <https://yunohost.org/app_example>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Official app website: <https://joinfirefish.org/>
|
||||
* Upstream app code repository: <https://git.joinfirefish.org/firefish/firefish>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_firefish>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/firefish_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/firefish_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/firefish_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 firefish -u https://github.com/YunoHost-Apps/firefish_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
36
README_fr.md
36
README_fr.md
|
|
@ -3,49 +3,51 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
|
|||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Example app pour YunoHost
|
||||
# Firefish pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://dash.yunohost.org/appci/app/firefish)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://install-app.yunohost.org/?app=firefish)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d’installer Example app rapidement et simplement sur un serveur YunoHost.
|
||||
> *Ce package vous permet d’installer Firefish 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
|
||||
|
||||
Ceci est une fausse description des fonctionalités de l'app
|
||||
Un fork grandement amélioré de Misskey avec une meilleure UI/UX, sécurité, fonctionnalités, et plus encore ! https://joinfirefish.org/
|
||||
|
||||
|
||||
**Version incluse :** 1.0~ynh1
|
||||
Firefish est basé sur Misskey, un puissant serveur de microblogging sur ActivityPub avec des fonctionnalités telles que des réactions emoji, une interface web personnalisable, des discussions riches, et bien plus encore !
|
||||
Firefish ajoute de nombreux changements de qualité de vie et des corrections de bogues pour les utilisateurs et les administrateurs d'instance.
|
||||
|
||||
**Démo :** https://demo.example.com
|
||||
|
||||
**Version incluse :** 1.0.3~ynh1
|
||||
|
||||
**Démo :** https://joinfirefish.org/
|
||||
|
||||
## Captures d’écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel 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://joinfirefish.org/>
|
||||
* Dépôt de code officiel de l’app : <https://git.joinfirefish.org/firefish/firefish>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_firefish>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/firefish_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/firefish_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/firefish_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade firefish -u https://github.com/YunoHost-Apps/firefish_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||
Loading…
Add table
Reference in a new issue