mirror of
https://github.com/YunoHost-Apps/h5ai_ynh.git
synced 2024-09-03 20:36:25 +02:00
Auto-update README
This commit is contained in:
parent
e59fb81964
commit
87b736d8e1
2 changed files with 45 additions and 23 deletions
31
README.md
31
README.md
|
@ -5,7 +5,7 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
# h5ai for YunoHost
|
# h5ai for YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![Working status](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg)
|
||||||
[![Install h5ai with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai)
|
[![Install h5ai with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
@ -15,15 +15,23 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Modern HTTP web server index for NGINX
|
h5ai is a modern file indexer for HTTP web servers with focus on your files. Directories are displayed in a appealing way and browsing them is enhanced by different views, a breadcrumb and a tree overview.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
There are lots of optional extensions and configuration options to customize the web appearance of your directory listings. All markup is valid HTML5 spiced up with CSS3 and finest JavaScript to build a fresh but minimal user interface and a user experience that focuses on your files.
|
||||||
|
|
||||||
|
Some of the optional features are: file sorting, different view modes, localization, a breadcrumb, a tree view, custom headers and footers, file filter and search, folder sizes, auto refresh, packaged download, QR codes, thumbnails, file previews
|
||||||
|
|
||||||
|
|
||||||
**Shipped version:** 0.30.0~ynh3
|
**Shipped version:** 0.30.0~ynh3
|
||||||
|
|
||||||
|
**Demo:** https://larsjung.de/h5ai/demo/
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![](./doc/screenshots/screenshot.jpg)
|
![Screenshot of h5ai](./doc/screenshots/screenshot.jpg)
|
||||||
|
![Screenshot of h5ai](./doc/screenshots/h5ai-1024x540.png)
|
||||||
|
|
||||||
## Disclaimers / important information
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
@ -35,21 +43,22 @@ The main configuration file is `_h5ai/private/conf/options.json`. You might want
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: https://larsjung.de/h5ai/
|
* Official app website: <https://larsjung.de/h5ai/>
|
||||||
* Official admin documentation: https://larsjung.de/h5ai/
|
* Official admin documentation: <https://larsjung.de/h5ai/>
|
||||||
* Upstream app code repository: https://github.com/lrsjng/h5ai
|
* Upstream app code repository: <https://github.com/lrsjng/h5ai>
|
||||||
* YunoHost documentation for this app: https://yunohost.org/app_h5ai
|
* YunoHost documentation for this app: <https://yunohost.org/app_h5ai>
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
* Report a bug: <https://github.com/YunoHost-Apps/h5ai_ynh/issues>
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing).
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
|
|
37
README_fr.md
37
README_fr.md
|
@ -1,25 +1,37 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# h5ai pour YunoHost
|
# h5ai pour YunoHost
|
||||||
|
|
||||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg)
|
||||||
[![Installer h5ai avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai)
|
[![Installer h5ai avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
|
||||||
|
|
||||||
> *Ce package vous permet d'installer h5ai rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d'installer h5ai 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.*
|
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
|
||||||
|
|
||||||
Serveur moderne d'index pour NGINX
|
h5ai is a modern file indexer for HTTP web servers with focus on your files. Directories are displayed in a appealing way and browsing them is enhanced by different views, a breadcrumb and a tree overview.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
There are lots of optional extensions and configuration options to customize the web appearance of your directory listings. All markup is valid HTML5 spiced up with CSS3 and finest JavaScript to build a fresh but minimal user interface and a user experience that focuses on your files.
|
||||||
|
|
||||||
|
Some of the optional features are: file sorting, different view modes, localization, a breadcrumb, a tree view, custom headers and footers, file filter and search, folder sizes, auto refresh, packaged download, QR codes, thumbnails, file previews
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 0.30.0~ynh3
|
**Version incluse :** 0.30.0~ynh3
|
||||||
|
|
||||||
|
**Démo :** https://larsjung.de/h5ai/demo/
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||
![](./doc/screenshots/screenshot.jpg)
|
![Capture d'écran de h5ai](./doc/screenshots/screenshot.jpg)
|
||||||
|
![Capture d'écran de h5ai](./doc/screenshots/h5ai-1024x540.png)
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
@ -31,21 +43,22 @@ Le fichier de configuration principal est `_h5ai / private / conf / options.json
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l'app : https://larsjung.de/h5ai/
|
* Site officiel de l'app : <https://larsjung.de/h5ai/>
|
||||||
* Documentation officielle de l'admin : https://larsjung.de/h5ai/
|
* Documentation officielle de l'admin : <https://larsjung.de/h5ai/>
|
||||||
* Dépôt de code officiel de l'app : https://github.com/lrsjng/h5ai
|
* Dépôt de code officiel de l'app : <https://github.com/lrsjng/h5ai>
|
||||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_h5ai
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_h5ai>
|
||||||
* Signaler un bug : https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
* Signaler un bug : <https://github.com/YunoHost-Apps/h5ai_ynh/issues>
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing).
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing).
|
||||||
|
|
||||||
Pour essayer la branche testing, procédez comme suit.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||||
|
|
Loading…
Reference in a new issue