1General Information
2===================
3
4This is libusb version @LIBUSB_VERSION@. libusb is a library which allows
5userspace application access to USB devices.
6
7The official ftp site is:
8  ftp://ftp.libusb.sourceforge.net/pub/libusb/
9
10The official web site is:
11  http://libusb.sourceforge.net/
12
13A mailing list is located at:
14  libusb-devel@lists.sourceforge.net
15
16Installation
17============
18
19See the file 'INSTALL'
20
21How to report bugs
22==================
23
24To report a bug, visit http://www.sourceforge.net/projects/libusb/ and fill
25out a bug report form.
26
27Please make sure to include:
28
29* The version of libusb
30
31* Information about your system. For instance:
32
33   - What operating system and version
34   - For Linux, what version of the C library
35
36  And anything else you think is relevant.
37
38* How to reproduce the bug. 
39
40  If you can reproduce it with the testlibusb program that is built 
41  in the libusb/ directory, that will be most convenient.  Otherwise, 
42  please include a short test program that exhibits the behavior. 
43  As a last resort, you can also provide a pointer to a larger piece 
44  of software that can be downloaded.
45
46* If the bug was a crash, the exact text that was printed out
47  when the crash occured.
48
49* Further information such as stack traces may be useful, but
50  is not necessary.
51
52Patches
53=======
54
55Patches can be sent to libusb-devel@lists.sourceforge.net.
56
57If the patch fixes a bug, it is usually a good idea to include
58all the information described in "How to Report Bugs".
59
60Building
61========
62
63It should be as simple as running these two commands:
64
65./configure
66make
67
68One common problem is building the SGML documentation. On some systems,
69like SuSE, you will need to set the SGML_CATALOG_FILES environment
70variable to something similar to this (actual paths may vary):
71
72export SGML_CATALOG_FILES="/usr/share/sgml/CATALOG.docbook_3:/usr/share/sgml/CATALOG.docbook-dsssl-stylesheets:/usr/share/sgml/openjade/catalog"
73
74On recent versions of Fedora Core (FC5 Test 2 atleast), this command may be
75needed:
76
77export SGML_CATALOG_FILES="/etc/sgml/catalog"
78
79or possibly:
80
81export SGML_CATALOG_FILES="/etc/sgml/docbook"
82
83C++ Support
84===========
85
86There are reasonable unit tests available - run "make check" to do the
87tests. Note that some of the tests will unexpectedly pass if you don't have
88a specfic type of Logitech mouse connected, and some are expected to fail
89unless you are running as root (or otherwise have permissions to access the
90device).
91
92Building the C++ documentation requires Doxygen
93(http://www.stack.nl/~dimitri/doxygen/) 
94
95