From cb96d297abb060584a8d1301412f61dcd117e978 Mon Sep 17 00:00:00 2001 From: nirenjan Date: Tue, 2 Jun 2020 16:36:01 -0700 Subject: [PATCH] Create INSTALL.md [skip ci] --- INSTALL.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 1 + README.md | 46 ++++---------------------------------------- 3 files changed, 60 insertions(+), 42 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..e6b5bda --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,55 @@ +Installation instructions for x52pro-linux +========================================== + +[![Build Status](https://www.travis-ci.org/nirenjan/x52pro-linux.svg?branch=master)](https://www.travis-ci.org/nirenjan/x52pro-linux) + +Build has been tested on the following operating systems (x86-64 only): + +* Ubuntu 16.04 LTS +* Ubuntu 18.04 LTS +* OS X 10.13.6 + +# Prerequisites + +## Required Packages + +* automake +* autoconf +* autopoint +* gettext +* libtool +* libusb-1.0 + headers +* pkg-config +* python (2.6 or greater) + +### Installation instructions + +| Platform | Install instructions | +| -------- | -------------------- | +| Ubuntu | `sudo apt-get install automake autoconf gettext autopoint libtool libusb-1.0-0-dev pkg-config python` | +| MacOS + Homebrew | `brew install automake autoconf gettext libtool libusb pkg-config python` | + +## Optional Packages + +If you want to generate HTML documentation for the library, and manpages for +the utilities, you will need the following packages: + +* doxygen +* rsync + +You will also need the following packages to run the unit tests: + +* faketime + +# Installation Instructions + +1. Clone the repository +2. Run autogen.sh +3. Run the following commands: +``` +./configure \ + --prefix=/usr \ + --with-udevrulesdir=$(pkg-config --variable=udevdir)/rules.d +make && sudo make install +``` + diff --git a/Makefile.am b/Makefile.am index ec9489a..0bdecee 100644 --- a/Makefile.am +++ b/Makefile.am @@ -18,6 +18,7 @@ EXTRA_DIST = \ AUTHORS \ ChangeLog.md \ Doxyfile.in \ + INSTALL.md \ LICENSE \ README.md \ config.rpath \ diff --git a/README.md b/README.md index 829b460..4201943 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Saitek X52Pro joystick driver for Linux ======================================= +[![Build Status](https://www.travis-ci.org/nirenjan/x52pro-linux.svg?branch=master)](https://www.travis-ci.org/nirenjan/x52pro-linux) + This project adds a new driver for the Saitek/MadCatz X52 Pro flight control system. The X52 pro is a HOTAS (hand on throttle and stick) with 7 axes, 39 buttons, 1 hat and 1 thumbstick and a multi-function @@ -14,46 +16,6 @@ capable of reading the joystick, but it cannot control the MFD or LEDs. Most of the extra functionality can be handled from userspace. See the individual folders for README information. -# Building - -[![Build Status](https://www.travis-ci.org/nirenjan/x52pro-linux.svg?branch=master)](https://www.travis-ci.org/nirenjan/x52pro-linux) - -Build has been tested on the following operating systems (x86-64 only): - -* Ubuntu 16.04 LTS -* Ubuntu 18.04 LTS -* OS X 10.13.6 - -## Prerequisites - -You will need the following packages: - -* automake -* autoconf -* autopoint -* gettext -* libtool -* libusb-1.0-0-dev (Package name may vary across distributions) -* pkg-config -* python (2.6 or greater) - -If you are on OSX, you can install the above packages using Homebrew - -If you want to generate HTML documentation for the library, and manpages for -the utilities, you will need the following packages: - -* doxygen -* rsync - -## Installation - -1. Clone the repository -2. Run autogen.sh -3. Run the following commands: -``` -./configure \ - --prefix=/usr \ - --with-udevrulesdir=$(pkg-config --variable=udevdir)/rules.d -make && sudo make install -``` +# Building and installing +See [INSTALL.md](https://github.com/nirenjan/x52pro-linux/blob/master/INSTALL.md)