Improve documentation

This commit is contained in:
Klaus Reimer 2018-10-21 12:22:03 +02:00
parent 5249c172f9
commit df699d2612
5 changed files with 104 additions and 92 deletions

View File

@ -53,3 +53,14 @@ org.usb4java.javax.scanInterval = 1000
((org.usb4java.javax.Services) UsbHostManager.getUsbServices()).scan();
+----+
* Use USBDK
If you want to use {{{https://github.com/daynix/UsbDk}USBDK}} on Windows
then you have to enable the feature with the following entry:
+----+
org.usb4java.javax.useUSBDK = true
+----+
This setting is ignored on other platforms.

View File

@ -20,7 +20,7 @@ Frequently asked questions
</etc/udev/rules.d/99-userusbdevices.rules> with content like this:
----
SUBSYSTEM=="usb",ATTR{idVendor}=="89ab",ATTR{idProduct}=="4567",MODE="0660",GROUP="wheel"
SUBSYSTEM=="usb",ATTR{idVendor}=="89ab",ATTR{idProduct}=="4567",MODE="0660",GROUP="plugdev"
----
This means that whenever a USB device with vendor id <0x89ab> and product id
@ -65,4 +65,3 @@ Frequently asked questions
should consult the libusb mailinglist or bug tracker instead. Never report a
problem in the libusb bug tracker or the libusb mailing list if you
can't reproduce the problem with a native C program!

View File

@ -22,9 +22,9 @@ Library loading
+-----------------------------------------------------------------------------+
natives/
org/usb4java/
linux-x86/libusb4java.so
windows-x86/libusb4java.dll
osx-x86/libusb4java.dylib
linux-x86-64/libusb4java.so
win32-x86-64/libusb4java.dll
darwin-x86-64/libusb4java.dylib
lib/
usb4java.jar
commons-lang3.jar
@ -85,12 +85,18 @@ $ git clone git://github.com/usb4java/libusb4java.git
$ cd libusb4java
+----
6. Compile the native library:
6. Create a build output directory and enter it:
+---
$ mkdir build
$ cd build
+---
7. Compile the native library:
+----
$ ./autogen.sh
$ ./configure --prefix=/
$ make install-strip DESTDIR=/tmp
$ cmake .. -DCMAKE_INSTALL_PREFIX=""
$ make install/strip DESTDIR=/tmp
+----
8. When compilation was successful then the native library can be found in
@ -101,7 +107,7 @@ $ make install-strip DESTDIR=/tmp
of your operating system and <ARCH> is your CPU architecture (Both
must match the names mentioned in the exception thrown by usb4java.)
If you can't use the GNU compiler or the autotools then you are on your own.
If you can't use the GNU compiler or cmake then you are on your own.
If you have some experience with compiling JNI libraries then I guess this
won't be hard for you. There are only a couple of source files in the <src>
sub folder. You could write a new simple Makefile or whatever is needed on
@ -112,4 +118,3 @@ $ make install-strip DESTDIR=/tmp
({{{http://groups.google.com/group/usb4java}Google group}}).
You can subscribe to it via email by sending a mail to
{{{mailto:usb4java+subscribe@googlegroups.com}usb4java+subscribe@googlegroups.com}}.

View File

@ -30,8 +30,5 @@ Quick start
switch to a different javax-usb implementation later without changing your
code. Another advantage is that this API is object oriented and is much
easier to use for Java developers. The disadvantage is that the javax-usb
specification is pretty old and may lack support for some newer USB
techniques provided by the low-level API.
specification is very old (maybe even abandoned) and may lack support for
some newer USB techniques provided by the low-level API.

View File

@ -14,8 +14,8 @@
through the <a href="usb4java-javax/">usb4java-javax extension</a>.
</p>
<p>
Supported platforms are <strong>Linux</strong> (x86 32/64 bit, ARM 32 bit),
<strong>OS X</strong> (x86 32/64 bit) and
Supported platforms are <strong>Linux</strong> (x86 32/64 bit, ARM 32/64 bit),
<strong>OS X</strong> (x86 64 bit) and
<strong>Windows</strong> (x86 32/64 bit). But other platforms may work
as well (as long as they have at least Java 6 and are supported by
libusb) by compiling the JNI library manually.
@ -26,12 +26,12 @@
<ul class="download">
<li>
Main library:<br />
<strong><a href="${artifactBaseUrl}.tar.bz2">${project.artifactId}-${project.version}.tar.bz2</a></strong><br />
<strong><a href="${artifactBaseUrl}.tar.xz">${project.artifactId}-${project.version}.tar.xz</a></strong><br />
<strong><a href="${artifactBaseUrl}.zip">${project.artifactId}-${project.version}.zip</a></strong><br />
</li>
<li>
javax-usb extension:<br />
<strong><a href="${javaxArtifactBaseUrl}.tar.bz2">${project.artifactId}-javax-${usb4javaJavaxVersion}.tar.bz2</a></strong><br />
<strong><a href="${javaxArtifactBaseUrl}.tar.xz">${project.artifactId}-javax-${usb4javaJavaxVersion}.tar.xz</a></strong><br />
<strong><a href="${javaxArtifactBaseUrl}.zip">${project.artifactId}-javax-${usb4javaJavaxVersion}.zip</a></strong><br />
</li>
<li><a href="${repoBaseUrl}/">Older versions and snapshots</a></li>