From 45663a3e81a24a2765f99e943665ed7216281419 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Thu, 24 Jun 2021 23:59:03 +0000 Subject: [PATCH] Auto-update README --- README.md | 74 ++++++++++++++++++++-------------------------------- README_fr.md | 55 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 45 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 07446a4..2e5cef7 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,49 @@ + + # WriteFreely for YunoHost [![Integration level](https://dash.yunohost.org/integration/writefreely.svg)](https://dash.yunohost.org/appci/app/writefreely) ![](https://ci-apps.yunohost.org/ci/badges/writefreely.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/writefreely.maintain.svg) [![Install WriteFreely with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=writefreely) -> *This package allows you to install WriteFreely quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install WriteFreely 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 -WriteFreely is a beautifully pared-down blogging platform that's simple on the surface, yet powerful underneath. -Can be run as Single User Blog or Multi User Instance. +For starting a minimalist, federated blog — or an entire community. -Each User can be limited from 1 to unlimited blogs. +**Shipped version:** 0.13.0~ynh1 -**Shipped version:** v0.13.0 - -## Important points to read before installing - -**WriteFreely** require a dedicated **root domain**, eg. writefreely.domain.tld +**Demo:** https://write.as/new ## Screenshots -![writefreely-screenshot1](https://user-images.githubusercontent.com/30271971/52228565-fa4ab300-28b2-11e9-8983-3eb8cdbc2262.png) +![](./doc/screenshots/screenshots2.png) +![](./doc/screenshots/screenshots1.png) -![writefreely-screenshot2](https://user-images.githubusercontent.com/30271971/52228579-00409400-28b3-11e9-8a1c-7625494c8747.png) +## Disclaimers / important information -## Demo +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * **WriteFreely** require a dedicated **root domain**, eg. writefreely.domain.tld + * i386 architectures not supported + * No LDAP and no HTTP auth supported -* [Official demo](https://write.as/new) +* Other infos that people should be aware of, such as: + * If User Mode is configured Multiple users, the app be used by multiple users + * Additionals parameters can be configured in Settings / Admin settings. -## Configuration +## Documentation and resources -Additionals parameters can be configure in Settings / admin settings. - -## Documentation - - * Official documentation: https://writefreely.org/start - -## YunoHost specific features - -#### Multi-user support - -No LDAP and no HTTP auth supported - -If User Mode is configured Multiple users, the app be used by multiple users - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/writefreely.svg)](https://ci-apps.yunohost.org/ci/apps/writefreely/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/writefreely.svg)](https://ci-apps-arm.yunohost.org/ci/apps/writefreely/) - -## Limitations - -* No known limitations. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/writefreely_ynh/issues - * App website: https://writefreely.org/ - * Upstream app repository: https://github.com/writeas/writefreely - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://writefreely.org +* Official user documentation: https://writefreely.org/start +* Upstream app code repository: https://github.com/writeas/writefreely +* YunoHost documentation for this app: https://yunohost.org/app_writefreely +* Report a bug: https://github.com/YunoHost-Apps/writefreely_ynh/issues ## Developer info @@ -73,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/writefreely_ynh/tree/ or sudo yunohost app upgrade writefreely -u https://github.com/YunoHost-Apps/writefreely_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..609129a --- /dev/null +++ b/README_fr.md @@ -0,0 +1,55 @@ +# WriteFreely pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/writefreely.svg)](https://dash.yunohost.org/appci/app/writefreely) ![](https://ci-apps.yunohost.org/ci/badges/writefreely.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/writefreely.maintain.svg) +[![Installer WriteFreely avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=writefreely) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer WriteFreely 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 + +Permet de créer un blog fédéré minimaliste ou une communauté entière. + +**Version incluse :** 0.13.0~ynh1 + +**Démo :** https://write.as/new + +## Captures d'écran + +![](./doc/screenshots/screenshots2.png) +![](./doc/screenshots/screenshots1.png) + +## Avertissements / informations importantes + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * **WriteFreely** require a dedicated **root domain**, eg. writefreely.domain.tld + * i386 architectures not supported + * No LDAP and no HTTP auth supported + +* Other infos that people should be aware of, such as: + * If User Mode is configured Multiple users, the app be used by multiple users + * Additionals parameters can be configured in Settings / Admin settings. + +## Documentations et ressources + +* Site officiel de l'app : https://writefreely.org +* Documentation officielle utilisateur : https://writefreely.org/start +* Dépôt de code officiel de l'app : https://github.com/writeas/writefreely +* Documentation YunoHost pour cette app : https://yunohost.org/app_writefreely +* Signaler un bug : https://github.com/YunoHost-Apps/writefreely_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/writefreely_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/writefreely_ynh/tree/testing --debug +ou +sudo yunohost app upgrade writefreely -u https://github.com/YunoHost-Apps/writefreely_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file