Skip to content
Snippets Groups Projects
Commit 41609878 authored by jjlustig's avatar jjlustig
Browse files

Update README.md

parent 6252de30
No related branches found
No related tags found
No related merge requests found
uBoard
# uBoard
# Install
A customizable mobile interface to control desktop mouse and keyboard commands
Open your mobile browser by scanning the QRCode or enter the URL, then you are able to control your desktop via browser.
# Setup
Open your mobile browser by scanning the QRCode or enter the URL, then you are able to control your desktop via browser. (NOT FULLY IMPLEMENTED)
## Setup
## Installation
To run the uBoard server you must have the following installed:
1. nodejs (7.5 or above)
2. NPM (5.6.0 or above)
3. Bower (1.8.2 or above)
2. npm (5.6.0 or above)
3. bower (1.8.2 or above)
Get required packages
......@@ -29,8 +31,8 @@ $ node server.js
To host the uBoard server on the desktop.
Next, find your desktop network IP address. To access the mobile component, open a web browser on your mobile device
and navigate to the IP address of your computer under port 8000
Next, locate your desktop network IP address. To access the mobile component, open a web browser on a mobile device
and navigate to the IP address of your computer, port 8000
## Code structure
......@@ -79,18 +81,18 @@ Additionally your desktop will need to have the appropriate c++ and python libra
python2 is required to run the robotjs library. Xcode c++ libraries are required to compile robotjs
To install the required c++ libraries:
To install the required c++ Libraries:
On mac, run
On Mac, run
```
xcode-select --install
```
On windows,
On windows, (TODO)
```
TODO(laurel): Fill this in
TODO: Fill this in
```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment