mirror of
https://github.com/YunoHost-Apps/bookwyrm_ynh.git
synced 2024-09-03 18:16:12 +02:00
54 lines
2.1 KiB
Markdown
54 lines
2.1 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# BookWyrm for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/bookwyrm)  
|
|
|
|
[](https://install-app.yunohost.org/?app=bookwyrm)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install BookWyrm 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
|
|
|
|
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
|
|
|
|
|
|
**Shipped version:** 0.7.2~ynh2
|
|
|
|
**Demo:** <https://joinbookwyrm.com/fr/>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## :red_circle: Antifeatures
|
|
|
|
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://joinbookwyrm.com/fr/>
|
|
- Official admin documentation: <https://docs.joinbookwyrm.com/>
|
|
- Upstream app code repository: <https://github.com/bookwyrm-social/bookwyrm>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/bookwyrm>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|