diff --git a/README.md b/README.md index 92d6ff9..0795d7d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # BicBucStriim for YunoHost -[![Integration level](https://dash.yunohost.org/integration/bicbucstriim.svg)](https://dash.yunohost.org/appci/app/bicbucstriim) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/bicbucstriim.svg)](https://dash.yunohost.org/appci/app/bicbucstriim) ![Working status](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.maintain.svg) + [![Install BicBucStriim with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bicbucstriim) *[Lire ce readme en français.](./README_fr.md)* @@ -20,11 +21,9 @@ BicBucStriim is a simple PHP application that runs in the Apache/PHP environment **Shipped version:** 1.5.3~ynh2 - - ## Screenshots -![](./doc/screenshots/bbs-121-recent.png) +![Screenshot of BicBucStriim](./doc/screenshots/bbs-121-recent.png) ## Disclaimers / important information @@ -40,20 +39,21 @@ A freshly installed BicBucStriim installation will show the login page. The init If you encounter problems, use the installation test to check your environment. Invoke this test by navigating to `http://domain.ltd/bbs/installcheck.php`. This test checks for problems that users experienced in the past. ## Documentation and resources -* Official app website: http://projekte.textmulch.de/bicbucstriim/ -* Upstream app code repository: https://github.com/rvolz/BicBucStriim -* YunoHost documentation for this app: https://yunohost.org/app_bicbucstriim -* Report a bug: https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues +* Official app website: +* Upstream app code repository: +* YunoHost Store: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug or 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 \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 0bae50a..704e303 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,26 +1,29 @@ + + # BicBucStriim pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/bicbucstriim.svg)](https://dash.yunohost.org/appci/app/bicbucstriim) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/bicbucstriim.svg)](https://dash.yunohost.org/appci/app/bicbucstriim) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.maintain.svg) + [![Installer BicBucStriim avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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.* +> *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 +## Vue d’ensemble BicBucStriim streams books, digital books. It was primarily designed to fill a gap in the functionality of 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 (or any other server). It assumes that you manage your e-book collection with Calibre. The application reads the [Calibre](https://calibre-ebook.com/) 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. **Version incluse :** 1.5.3~ynh2 +## Captures d’écran - -## Captures d'écran - -![](./doc/screenshots/bbs-121-recent.png) +![Capture d’écran de BicBucStriim](./doc/screenshots/bbs-121-recent.png) ## Avertissements / informations importantes @@ -34,20 +37,21 @@ Une installation de BicBucStriim fraîchement installée affichera la page de co mot de passe : admin ## Documentations et ressources -* Site officiel de l'app : http://projekte.textmulch.de/bicbucstriim/ -* Dépôt de code officiel de l'app : https://github.com/rvolz/BicBucStriim -* Documentation YunoHost pour cette app : https://yunohost.org/app_bicbucstriim -* Signaler un bug : https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues +* Site officiel de l’app : +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : ## 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. -``` + +``` bash 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 \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file