dan/console-hub
1
0
Fork 0
mirror of https://github.com/danbulant/console-hub synced 2026-06-17 21:41:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add installation guide

Browse source
This commit is contained in:
Daniel Bulant 2019-06-22 21:26:24 +02:00 committed by GitHub
parent be1e13e96d
commit 5cff02e495
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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.