Browse Source

Extended Readme

Thomas Buck 9 years ago
parent
commit
1ac769723a
1 changed files with 16 additions and 2 deletions
  1. 16
    2
      README.md

+ 16
- 2
README.md View File

@@ -4,9 +4,11 @@ This project emulates a virtual Gamepad using input data from a serial port. Thi
4 4
 
5 5
 Depending on the USB-Serial converter stick included with your Transmitter, you may need to install the [SiLabs CP210x driver](https://www.silabs.com/products/mcu/Pages/USBtoUARTBridgeVCPDrivers.aspx).
6 6
 
7
-You need to install the virtual userspace IOKit HID driver [foohid](https://github.com/unbit/foohid).
7
+You also need to install the virtual userspace IOKit HID driver [foohid](https://github.com/unbit/foohid).
8 8
 
9
-Download the latest release **including foohid** [here on GitHub](https://github.com/xythobuz/SerialGamepad/releases).
9
+Download the latest release (**already including foohid**) [here on GitHub](https://github.com/xythobuz/SerialGamepad/releases).
10
+
11
+This software has been tested on OS 10.10 (Yosemite) and 10.11 (El Capitan).
10 12
 
11 13
 ## SerialGamepad GUI App
12 14
 
@@ -14,6 +16,10 @@ This app can connect to a compatible transmitter over a serial port and then pro
14 16
 
15 17
 ![Screenshot](https://i.imgur.com/x0hnWq5.png)
16 18
 
19
+First, press `Connect` to establish a connection to your Transmitter. As soon as it is working the current stick positions will be visualized. Then, press `Create` to create a virtual HID Gamepad.
20
+
21
+As long as both have been initialized, you can use your Transmitter in your Simulator. The connection will be closed and the virtual device destroyed automatically when you close the App window.
22
+
17 23
 ## foohid command-line app
18 24
 
19 25
 This small utility does the same thing as the SerialGamepad.app without a graphical user interface.
@@ -22,6 +28,14 @@ This small utility does the same thing as the SerialGamepad.app without a graphi
22 28
 
23 29
 This small utility only reads the channel values from a serial port and pretty-prints them to a POSIX compatible terminal.
24 30
 
31
+# For Developers
32
+
33
+You don’t need to use the included Makefile if you want to change something in the GUI App. Just directly open the XCode project file.
34
+
35
+However, the makefile allows you not only to build the GUI app, but also a distributable Installer including the foohid dependency. For this, just run `make distribute`. The finished installer will be placed in `bin/SerialGamepad.pkg`.
36
+
37
+To build the command-line apps and the GUI apps, just run `make all`. You can also install all of them using `sudo make install`. The cli-binaries will go to `/usr/local/bin`, the App to `/Applications`.
38
+
25 39
 ## Other Resources
26 40
 
27 41
  * [Serial protocol analysis](http://www.rcgroups.com/forums/showpost.php?p=11384029&postcount=79)

Loading…
Cancel
Save