diff --git a/README.md b/README.md index a22ec86..a0ac869 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,46 @@ + +# epicyon for YunoHost -# Epicyon app for YunoHost +[![Integration level](https://dash.yunohost.org/integration/epicyon.svg)](https://dash.yunohost.org/appci/app/epicyon) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.maintain.svg) +[![Install epicyon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=epicyon) -[![Integration level](https://dash.yunohost.org/integration/epicyon.svg)](https://dash.yunohost.org/appci/app/epicyon) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.maintain.svg) +*[Lire ce readme en français.](./README_fr.md)* -[![Install Epicyon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=epicyon) - -> *This package allows you to install Epicyon quickly and simply on a YunoHost server. +> *This package allows you to install epicyon 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 -ActivityPub server implementing S2S and C2S protocols, suitable for single board computers. Includes features such as moderation tools, post expiry, content warnings, and image descriptions -**Shipped version:** 01.03.2021 +Federated social network server + +**Shipped version:** 1.03.2021~ynh2 + + ## Screenshots -![](https://user-content.gitlab-static.net/930ea132a7a3a86dbc20782644a54e80a646d5f3/68747470733a2f2f65706963796f6e2e6e65742f696d672f73637265656e73686f745f6c696768742e6a7067) +![](./doc/screenshots/screenshot_starlight.jpg) -![](https://user-content.gitlab-static.net/3e7464f70018b45c4664ec28a98f3b39ea2258f8/68747470733a2f2f65706963796f6e2e6e65742f696d672f73637265656e73686f745f737461726c696768742e6a7067) +## Documentation and resources -![](https://user-content.gitlab-static.net/3a2f50083b88e221883ae2d70ddf86a4d79ef466/68747470733a2f2f65706963796f6e2e6e65742f696d672f73637265656e73686f745f6c6f67696e2e6a7067) - - -## YunoHost specific features - -#### Multi-user support - -Are LDAP and HTTP auth supported? NO -Can the app be used by multiple users? Yes - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/epicyon%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/epicyon/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/epicyon%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/epicyon/) - - -**More info on the documentation page:** -https://yunohost.org/packaging_apps - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/epicyon/issues - * App website: https://epicyon.net/ - * Upstream app repository: https://gitlab.com/bashrc2/epicyon/ - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://epicyon.net +* Upstream app code repository: hhttps://gitlab.com/bashrc2/epicyon/ +* YunoHost documentation for this app: https://yunohost.org/app_epicyon +* Report a bug: https://github.com/YunoHost-Apps/epicyon_ynh/issues ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/epicyon/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/epicyon/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing --debug or -sudo yunohost app upgrade epicyon -u https://github.com/YunoHost-Apps/epicyon/tree/testing --debug +sudo yunohost app upgrade epicyon -u https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..4b55446 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,42 @@ +# epicyon pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/epicyon.svg)](https://dash.yunohost.org/appci/app/epicyon) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/epicyon.maintain.svg) +[![Installer epicyon avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=epicyon) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer epicyon 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 + +Serveur de réseau social fédéré + +**Version incluse :** 1.03.2021~ynh2 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot_starlight.jpg) + +## Documentations et ressources + +* Site officiel de l'app : https://epicyon.net +* Dépôt de code officiel de l'app : hhttps://gitlab.com/bashrc2/epicyon/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_epicyon +* Signaler un bug : https://github.com/YunoHost-Apps/epicyon_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing --debug +ou +sudo yunohost app upgrade epicyon -u https://github.com/YunoHost-Apps/epicyon_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file