From c1f3b6abdf16ca582544356509f8b4b3b5c452d6 Mon Sep 17 00:00:00 2001 From: nirenjan Date: Mon, 30 Nov 2015 23:37:22 -0800 Subject: [PATCH] Add installation instructions --- libx52/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/libx52/README.md b/libx52/README.md index 55fec9b..7b42c8a 100644 --- a/libx52/README.md +++ b/libx52/README.md @@ -16,3 +16,23 @@ the above HOTAS. Note that when writing text to the MFD, the line length is limited to 16 characters. While you can pass a longer string, the library will only consider the first 16 characters for writing to the display. + +# Building the library + +Build has been tested on Ubuntu 14.04 LTS on x86_64. +## Prerequisites + +You will need the following packages: + +* automake +* autoconf +* libusb-1.0-0-dev + +## Installation + +1. Clone the parent Git repository +2. CD to the libx52 folder and run autogen.sh +3. Run configure; make and sudo make install. + +The test program is not installed, there will be a separate command line utility +in the future that utilizes the library and communicates with the joystick.