From d9740e8eb73b8a435ec7bcd1418fe39e1bbee2d4 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sun, 9 May 2021 10:18:04 +0200 Subject: [PATCH] Some doc update --- README.md | 14 ++++++++++++-- README_fr.md | 40 +++++++++++++++++++++++++--------------- 2 files changed, 37 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d846c11..6c6aa0f 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,21 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -Quick description of this app. +The RetroArch Web Player is RetroArch compiled through [Emscripten](http://kripken.github.io/emscripten-site/). RetroArch is the reference frontend for the libretro API. +Popular examples of implementations for this API includes video game system emulators and game engines as well as more generalized 3D programs. +These programs are instantiated as dynamic libraries. We refer to these as "libretro cores". In our case, these cores are emulators + +* cannot save game, in fact, cannot write at all... so configuration is lost each time you start again +* no user management +* some core are listed but not implemented : they do not work, the issue is from the upstream app. +* Games are located in `/opt/yunohost/retroarch/assets/cores`. A symbolic link is created to this folder in `/home/yunohost.multimedia/share/Games`, so that you can place your games from here +* cores have to be indexed to work : script `/opt/yunohost/retroarch/indexer.sh` run every 10 minutes to index all games in `opt/yunohost/retroarch/assets/cores` **Shipped version:** 1.9.1 ## Screenshots -![](Link to an screenshot for this app) +![](https://github.com/libretro/RetroArch/blob/master/docs/ozone-main-menu.jpg) ## Demo @@ -48,6 +56,8 @@ Can the app be used by multiple users? * Any known limitations. + + ## Additional information * Other information you would add about this application diff --git a/README_fr.md b/README_fr.md index 6486bb1..4d3df85 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,26 +1,36 @@ -##DEVELOPPEMENT EN COURS - N'UTILISER PAS! +##DEVELOPPEMENT EN COURS - NE PAS UTILISER! # App exemple pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) -[![Installer REPLACEBYYOURAPP avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) +[![Niveau d'intégration](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) +[![Installer retroarch avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=retroarch) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur Yunohost. +> *Ce package vous permet d'installer retroarch 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 -Description rapide de cette application. +Le Web Player Retroarch utilise RetroArch compilé grace à [Emscripten](http://kripken.github.io/emscripten-site/).RetroArch est le frontend de référence pour l'API libretro. +Des exemple populaires d'implémentations de cette API incluent des émulateurs de jeux vidéos et de moteur de jeux ainsi que des programmes 3D plus généraux. +Ces programmes sont instanciés comme bibliothèques dynamiques, appelées "libretro cores". -**Version incluse:** 1.0 +* On ne peut pas sauvegarder. En fait, on ne peut pas écrire dans les fichiers du tout, donc la configuration est perdue à chaque fois +* Pas de gestion d'utilisateurs +* certains cores sont listés mais ne sont pas implémentés : ils ne fonctionnent donc pas, le problème vient de l'application elle même. +* Les jeux sont situés dans `/opt/yunohost/retroarch/assets/cores`. Un lien symbolique est créé vers `/home/yunohost.multimedia/share/Games` de façon à ce que vous puissiez les y mettre facilement. +* Les cores doivent être indexés pour fonctionner : le script `/opt/yunohost/retroarch/indexer.sh` tourne toutes les 10 minutes pour indexer tous les jeux dans `opt/yunohost/retroarch/assets/cores` + + + +**Version incluse:** 1.9.1 ## Captures d'écran -![](Lien vers une capture d'écran pour cette application) +![](https://github.com/libretro/RetroArch/blob/master/docs/ozone-main-menu.jpg) ## Démo -* [Démo officielle](Lien vers un site de démonstration pour cette application) +* [Démo officielle](https://web.libretro.com/) ## Configuration @@ -40,9 +50,9 @@ L'application peut-elle être utilisée par plusieurs utilisateurs? #### Architectures supportées -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/) +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/retroarch/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/retroarch/) ## Limitations @@ -57,7 +67,7 @@ https://yunohost.org/packaging_apps ## Liens - * Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues + * Signaler un bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues * Site de l'application: Lien vers le site officiel de cette application * Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale * Site web YunoHost: https://yunohost.org/ @@ -68,11 +78,11 @@ Informations pour les développeurs ---------------- **Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug ou -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade retroarch -u https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug ```