Skip to content

Commit 368eab2

Browse files
committed
Update README.md
Changes: - Merged parts of the documentation with README.md - Small fixups/additions to README.md
1 parent d84a41f commit 368eab2

File tree

1 file changed

+44
-8
lines changed

1 file changed

+44
-8
lines changed

README.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,57 @@
11
libpifacedigital
22
================
3-
A simple library for controlling PiFace Digital. See `example.c` for example
4-
usage. Hides the SPI file descriptors so the user only has to deal with
5-
`hw_addr`.
3+
4+
A simple library for controlling
5+
[PiFace Digital](http://www.piface.org.uk/products/piface_digital/).
6+
Hides the SPI file descriptors so the user only has to deal with `hw_addr`.
7+
8+
Building
9+
--------
10+
11+
To build the library, first install the required dependency
12+
[libmcp23s17](https://github.com/piface/libmcp23s17). Then run:
13+
14+
$ make
15+
16+
Install the library to `/usr/local` using:
17+
18+
$ make install
19+
20+
To test the library, compile and execute the example program:
21+
22+
$ make example
23+
$ ./example
24+
25+
A command line utility named `pifacedigital` is also available. Build with:
26+
27+
$ make pifacedigital
28+
$ ./pifacedigital read input
29+
$ ./pifacedigital --help
30+
31+
Usage
32+
-----
33+
34+
See `example.c` for example usage.
35+
36+
Compile your software with the following flags:
37+
38+
-lpifacedigital -lmcp23s17
39+
40+
You can specify the path of the libraries manually, using:
41+
42+
-I/path/to/headers -L/path/to/libpifacedigital -lpifacedigital -L/path/to/mcp23s17 -lmcp23s17
643

744
Documentation
845
-------------
946

10-
[http://piface.github.io/libpifacedigital](http://piface.github.io/libpifacedigital)
47+
An online version of the documentation is available at http://piface.github.io/libpifacedigital.
1148

12-
Build the docs with:
49+
Build it with (assuming that you are in the directory of the cloned repository):
1350

14-
$ git clone https://github.com/piface/libpifacedigital.git
15-
$ cd libpifacedigital/docs/
51+
$ cd docs/
1652
$ doxygen pifacedigital-doc.conf
1753

18-
To view as HTML, point your browser to `libpifacedigital/docs/html/index.html`.
54+
To view as HTML, point your browser to `docs/html/index.html`.
1955

2056
To view as PDF:
2157

0 commit comments

Comments
 (0)