uhk/agent
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify the difference between the two builds.

Browse Source
This commit is contained in:
László Monda
2017-12-23 19:20:26 +01:00
committed by GitHub
parent 0b69d01a0d
commit f0a54768d4
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -7,6 +7,16 @@ Agent is the configuration application of the [Ultimate Hacking Keyboard](https:
[Give it a whirl!](http://ultimatehackingkeyboard.github.io/agent/)
## Two builds to rule them all
It's worth mentioning that Agent has two builds.
The **electron build** is the desktop application which is meant to be used if you have an actual UHK at hand. It starts with an opening screen which detects your UHK. You cannot get past this screen without connecting a UHK via USB.
The **web build** is meant to be used for demonstation purposes, so people who don't yet own a UHK can get a feel of Agent and its capabilities in their browser. Eventually, WebUSB support will be added to the web build, making it able to communicate with the UHK. Given the sandboxed nature of browers, the web build will always lack features that the electron build offers, so this won't make the electron build obsolete.
The two builds share code as much as possible.
## Set up instructions
First up, make sure that node >=8.1.x and npm >=5.1.x are installed on your system. Next up: