From 5d96e6869f68542a3cff18220ee37b18bcfdbf30 Mon Sep 17 00:00:00 2001 From: DjLeChuck Date: Sun, 2 Oct 2016 15:09:15 +0200 Subject: [PATCH] Update README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4c33d93..7366341 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # recalbox-manager A web interface to manage recalbox configuration -## Installation +## Installation from sources 1. Clone or download the repository: `git clone https://github.com/DjLeChuck/recalbox-manager.git` 2. Install all the requirements from a computer (not recalbox): `npm install` -3. Copy the folder on recalbox : `\recalbox\share\manager` for example +3. Copy the folder on recalbox: `\recalbox\share\manager` for example 4. Activate the API: https://github.com/recalbox/recalbox-api/blob/1.1.x/documentation/activate-on-recalbox.md 5. Launch the server (connect through SSH on the recalbox): `cd /recalbox/share/manager && node app.js` 6. Go on http://recalbox:3000/ + +## Installation from releases +1. Download the release: https://github.com/DjLeChuck/recalbox-manager/releases/ +2. Extract the package on recalbox: `\recalbox\share\manager` for example +3. Activate the API: https://github.com/recalbox/recalbox-api/blob/1.1.x/documentation/activate-on-recalbox.md +4. Launch the server (connect through SSH on the recalbox): `cd /recalbox/share/manager && node app.js` +5. Go on http://recalbox:3000/ + +## Known issues +* There is a problem with string values and the recalbox API which corrupts parameters like SSID, controllers' params, etc.. We must wait the next version of the API to fix the problem. +* Les modifications ne sont pas directement appliquées; Le recalbox doit être redémarré.