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

Update readme (#547)

Browse Source 
* Fix typos

* Update build instructions
This commit is contained in:
Andrew Kraut
2018-01-07 10:56:24 -08:00
committed by László Monda
parent 5341d953ff
commit 46f855d1db
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -13,23 +13,30 @@ 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 **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 **web build** is meant to be used for demonstration 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 browsers, 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. The two builds share code as much as possible.
## Building the electron application ## Building the electron application
First up, make sure that node >=8.1.x and npm >=5.1.x are installed on your system. Next up: ### Step 1: Build Dependencies
You'll need Node (>=8.1.x) and NPM (>=5.1.x). Use your OS package manager to install these. [Check the NodeJS site for more info.](https://nodejs.org/en/download/package-manager/ "Installing Node.js via package manager") Mac OS users can simply `brew install node` to get both.
You'll also need `libusb`.
On debian-based linux distros, `apt-get install libusb-dev libudev-dev g++` is sufficient.
On Mac OS, use `brew install libusb libusb-compat`.
For everyone else, use the appropriate package manager for your OS.
### Step 2: Build Environment
If your
``` ```
# Execute the following line on Linux. Use relevant package manager and package names on non-Debian based distros.
apt-get install libusb-dev libudev-dev g++
git clone git@github.com:UltimateHackingKeyboard/agent.git git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent cd agent
npm install npm install # to install Node dependencies
npm run build:electron npm run build:electron # to build the agent
npm run electron npm run electron # to run the newly built agent
``` ```
At this point, Agent should be running on your machine. At this point, Agent should be running on your machine.