From 5cff02e495d57c65f5ec46ece866a328e72d9b91 Mon Sep 17 00:00:00 2001 From: Daniel Bulant Date: Sat, 22 Jun 2019 21:26:24 +0200 Subject: [PATCH] Add installation guide --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 0e2b6b6..ee48eba 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # console-hub Hub application to be controlled with controller (gamepad) through gamepad HTML5 API +## Installation +Installation can be done both with electron and on normal websites. +### Electron +If you have installed node.js and electron, you can build the app yourself. +For packaging, I personally use (and prefer) [electron-packager](https://github.com/electron-userland/electron-packager). +Use all files in the repository (electron-packager .) +### Website +If you want this console to be available online, please keep in mind that it is **NOT** the intended way to use. There are several known bugs (not working settings, some modules undefined). +To install, just upload all files onto your hosting and access /html/ (index.html in root redirects there). +## Add missing files +Because of legal issues (Copyright, cannot upload publicly), fonts and styles are missing. To fix that, you must do following steps: +* **download material icons**: First of all, you need to download material icons. Stylesheet is made to include style.css from /html/iconfont/ where downloaded material icon pack should be. You can download them [github](http://github.com/google/material-design-icons/) +* **download open sans**: Because of legal issues, I cannot place here direct link. One that I use is [font-squirrel](https://www.fontsquirrel.com/fonts/open-sans). Put all the files in /html/opensans/. Styles.css will automatically include them. +If you did everything correctly, Console hub now have all required files to run.