diff --git a/README.md b/README.md index 6206acf..0c64e06 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,25 @@ Ultimarc-linux Library and command line utility -## Introduction: +#### Introduction: This utility will configure the following Ultimarc boards; I-Pac 2, I-Pac 4, Mini-Pac, UltraStik 360 and PacLED64. It uses json configuration files to configure the different boards. It also supports the ability to change the device ID of the UltraStik 360 boards. Allowing for the configuring of four different boards at once. -## Required Libraries +#### Required Libraries To build this tool the following libraries need to be install on your system. * json-c (0.11), * libusb-dev (1.0.18) * libtool -## UDEV Rule: +#### UDEV Rule: This utility requires folder permission changes to the usb device directories before it can do the configuration changes to the boards. The udev rule in the base directory named 21-ultimarc.rules needs to be placed in /etc/udev/rules.d directory. Placing the file in that directory usually requires root permissions. -## Building Utility: +#### Building Utility: To build this project, at the base directory run the following commands * ./configure * make The executable will be in src/umtool directory and named umtool.out. -## Project TODO's: +#### Project TODO's: * Ability to change the device ID for the PacLED64 * Robust file validation and boundary checking * Robust debugging capability