Create INSTALL.md

[skip ci]
pull/22/head
nirenjan 2020-06-02 16:36:01 -07:00
parent c2c852cee1
commit cb96d297ab
3 changed files with 60 additions and 42 deletions

55
INSTALL.md 100644
View File

@ -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
```

View File

@ -18,6 +18,7 @@ EXTRA_DIST = \
AUTHORS \ AUTHORS \
ChangeLog.md \ ChangeLog.md \
Doxyfile.in \ Doxyfile.in \
INSTALL.md \
LICENSE \ LICENSE \
README.md \ README.md \
config.rpath \ config.rpath \

View File

@ -1,6 +1,8 @@
Saitek X52Pro joystick driver for Linux 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 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) 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 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 Most of the extra functionality can be handled from userspace. See
the individual folders for README information. the individual folders for README information.
# Building # Building and installing
[![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
```
See [INSTALL.md](https://github.com/nirenjan/x52pro-linux/blob/master/INSTALL.md)