From 6252de30933b89b81416fda724a7edbd298e5723 Mon Sep 17 00:00:00 2001 From: jjlustig <jjlustig@umich.edu> Date: Wed, 21 Feb 2018 14:56:02 -0500 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9d916ae..b5b96e9 100755 --- a/README.md +++ b/README.md @@ -4,12 +4,15 @@ uBoard Open your mobile browser by scanning the QRCode or enter the URL, then you are able to control your desktop via browser. -## Features - -### Passcode protection ## Setup + +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) + Get required packages ``` @@ -26,11 +29,14 @@ $ 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 + ## Code structure The server uses `server.js` and the `socket.io` to change the mouse position and receive keyboard input -The desktop uses `desktop.html` to display the QR code on the desktop window. +The desktop uses `desktop.html` to display the QR code on the desktop window. (NOT FULLY IMPLEMENTED YET) For the client side, a mobile device will receive `index.html` and its attached `client.js`. This allows the User to input the keyboard (bottom half of screen) or move the mouse (top half of screen) and emit a WebSocket signal to the server. @@ -71,7 +77,7 @@ device will load the keyboard layout you set. Additionally your desktop will need to have the appropriate c++ and python libraries -python2 is required to run the robotjs library +python2 is required to run the robotjs library. Xcode c++ libraries are required to compile robotjs To install the required c++ libraries: -- GitLab