mirror of
https://github.com/YunoHost-Apps/writefreely_ynh.git
synced 2024-09-03 20:36:02 +02:00
Auto-update README
This commit is contained in:
parent
6fc40509fd
commit
45663a3e81
2 changed files with 84 additions and 45 deletions
70
README.md
70
README.md
|
@ -1,67 +1,49 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# WriteFreely for YunoHost
|
# WriteFreely for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/writefreely)  
|
[](https://dash.yunohost.org/appci/app/writefreely)  
|
||||||
[](https://install-app.yunohost.org/?app=writefreely)
|
[](https://install-app.yunohost.org/?app=writefreely)
|
||||||
|
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install WriteFreely quickly and simply on a YunoHost server.
|
> *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.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## 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
|
**Demo:** https://write.as/new
|
||||||
|
|
||||||
## Important points to read before installing
|
|
||||||
|
|
||||||
**WriteFreely** require a dedicated **root domain**, eg. writefreely.domain.tld
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||

|
## 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 - [](https://ci-apps.yunohost.org/ci/apps/writefreely/)
|
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/writefreely/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
* No known limitations.
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
|
* 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
|
* 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/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
|
@ -73,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/writefreely_ynh/tree/
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade writefreely -u https://github.com/YunoHost-Apps/writefreely_ynh/tree/testing --debug
|
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
|
55
README_fr.md
Normal file
55
README_fr.md
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
# WriteFreely pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/writefreely)  
|
||||||
|
[](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
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
## 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
|
Loading…
Add table
Reference in a new issue