diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..293a1c7 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +<!--- +SPDX-License-Identifier: GPL-2.0-or-later +Copyright (c) 2018 Greg Kroah-Hartman <gregkh@linuxfoundation.org> +--> +# usbutils + +This is a collection of USB tools for use on Linux and BSD systems to +query what type of USB devices are connected to the system. This is to +be run on a USB host (i.e. a machine you plug USB devices into), not on +a USB device (i.e. a device you plug into a USB host.) + +## Building and installing + +Note, usbutils depends on libusb, be sure that library is properly +installed first. + +To work with the "raw" repo, after cloning it just do: + + ./autogen.sh + +Or if you like doing things "by hand" you can try the following: + +Get the usbhid-dump git submodule: + + git submodule init + git submodule update + +Initialize autobuild with: + + autoreconf --install --symlink + +Configure the project with: + + ./configure + +Build everything with: + + make + +Install it, if you really want to, with: + + make install + +## Source location + +The source for usbutils can be found in many places, depending on the git +hosting site you prefer. Here are the primary locations, in order of +preference by the maintainer: + + https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usbutils.git/ + https://git.sr.ht/~gregkh/usbutils + https://github.com/gregkh/usbutils |