mirror of
https://github.com/YunoHost-Apps/BicBucStriim_ynh.git
synced 2024-09-03 18:15:53 +02:00
Auto-update README
This commit is contained in:
parent
d48827b4d7
commit
e3fb31e719
2 changed files with 50 additions and 47 deletions
61
README.md
61
README.md
|
@ -1,65 +1,30 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# BicBucStriim for YunoHost
|
# BicBucStriim for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/bicbucstriim)  
|
[](https://dash.yunohost.org/appci/app/bicbucstriim)  
|
||||||
[](https://install-app.yunohost.org/?app=bicbucstriim)
|
[](https://install-app.yunohost.org/?app=bicbucstriim)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install BicBucStriim quickly and simply on a YunoHost server.
|
> *This package allows you to install BicBucStriim 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
|
||||||
BicBucStriim streams books, digital books. It fills a gap in the functionality of current NAS devices that provide access to music, videos and photos -- but not books. BicBucStriim fills this gap and provides web-based access to your e-book collection.
|
|
||||||
|
|
||||||
BicBucStriim is a simple PHP application that runs in the Apache/PHP environment provided by the NAS. It assumes that you manage your e-book collection with Calibre. The application reads the Calibre data and publishes it in HTML form. To access the e-book catalog you simply point your ebook reader to your NAS, select one of your e-books and download it.
|
Digital books streamer, providing web-based access to your e-book collection.
|
||||||
|
|
||||||
**Shipped version:** 1.5.0
|
**Shipped version:** 1.5.3~ynh1
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Demo
|
## Documentation and resources
|
||||||
|
|
||||||
* [Official demo](Link to a demo site for this app.)
|
* YunoHost documentation for this app: https://yunohost.org/app_bicbucstriim
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues
|
||||||
## Configuration
|
|
||||||
|
|
||||||
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Official documentation: Link to the official documentation of this app
|
|
||||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
||||||
|
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Multi-user support
|
|
||||||
|
|
||||||
* Are LDAP and HTTP auth supported?
|
|
||||||
* Can the app be used by multiple users?
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/bicbucstriim/)
|
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/bicbucstriim/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
* Any known limitations.
|
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
* Other info you would like to add about this app.
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues
|
|
||||||
* App website: http://projekte.textmulch.de/bicbucstriim/
|
|
||||||
* Upstream app repository: https://github.com/rvolz/BicBucStriim
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
|
@ -71,3 +36,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade bicbucstriim -u https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug
|
sudo yunohost app upgrade bicbucstriim -u https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
36
README_fr.md
Normal file
36
README_fr.md
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
# BicBucStriim pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/bicbucstriim)  
|
||||||
|
[](https://install-app.yunohost.org/?app=bicbucstriim)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer BicBucStriim 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
|
||||||
|
|
||||||
|
Interface web pour accéder à votre collection d'e-book.
|
||||||
|
|
||||||
|
**Version incluse :** 1.5.3~ynh1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_bicbucstriim
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade bicbucstriim -u https://github.com/YunoHost-Apps/bicbucstriim_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