|
|
|
|
@@ -3,7 +3,7 @@ Introduction
|
|
|
|
|
|
|
|
|
|
[![Build Status][ciimg]][ci]
|
|
|
|
|
[![GoDoc][docimg]][doc]
|
|
|
|
|
[](https://coveralls.io/github/kylelemons/gousb?branch=gousb2.0-dev)
|
|
|
|
|
[![Coverage Status][coverimg]][cover]
|
|
|
|
|
|
|
|
|
|
The gousb package is an attempt at wrapping the libusb library into a Go-like binding.
|
|
|
|
|
|
|
|
|
|
@@ -13,18 +13,18 @@ Supported platforms include:
|
|
|
|
|
- darwin
|
|
|
|
|
- windows
|
|
|
|
|
|
|
|
|
|
[ciimg]: https://travis-ci.org/kylelemons/gousb.svg?branch=gousb2.0-dev
|
|
|
|
|
[ci]: https://travis-ci.org/kylelemons/gousb?branch=gousb2.0-dev
|
|
|
|
|
[docimg]: https://godoc.org/github.com/kylelemons/gousb?status.svg
|
|
|
|
|
[doc]: https://godoc.org/github.com/kylelemons/gousb
|
|
|
|
|
[coverimg]: https://coveralls.io/repos/github/google/gousb/badge.svg
|
|
|
|
|
[cover]: https://coveralls.io/github/google/gousb
|
|
|
|
|
[ciimg]: https://travis-ci.org/google/gousb.svg
|
|
|
|
|
[ci]: https://travis-ci.org/google/gousb
|
|
|
|
|
[docimg]: https://godoc.org/github.com/google/gousb?status.svg
|
|
|
|
|
[doc]: https://godoc.org/github.com/google/gousb
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
Because I am a Google employee, contributing to this project will require signing the [Google CLA][cla].
|
|
|
|
|
Contributing to this project will require signing the [Google CLA][cla].
|
|
|
|
|
This is the same agreement that is required for contributing to Go itself, so if you have
|
|
|
|
|
already filled it out for that, you needn't fill it out again.
|
|
|
|
|
You will need to send me the email address that you used to sign the agreement
|
|
|
|
|
so that I can verify that it is on file before I can accept pull requests.
|
|
|
|
|
|
|
|
|
|
[cla]: https://cla.developers.google.com/
|
|
|
|
|
|
|
|
|
|
@@ -41,7 +41,7 @@ Example: lsusb
|
|
|
|
|
--------------
|
|
|
|
|
The gousb project provides a simple but useful example: lsusb. This binary will list the USB devices connected to your system and various interesting tidbits about them, their configurations, endpoints, etc. To install it, run the following command:
|
|
|
|
|
|
|
|
|
|
go get -v github.com/kylelemons/gousb/lsusb
|
|
|
|
|
go get -v github.com/google/gousb/lsusb
|
|
|
|
|
|
|
|
|
|
gousb
|
|
|
|
|
-----
|
|
|
|
|
@@ -49,11 +49,11 @@ If you installed the lsusb example, both libraries below are already installed.
|
|
|
|
|
|
|
|
|
|
Installing the primary gousb package is really easy:
|
|
|
|
|
|
|
|
|
|
go get -v github.com/kylelemons/gousb/usb
|
|
|
|
|
go get -v github.com/google/gousb/usb
|
|
|
|
|
|
|
|
|
|
There is also a `usbid` package that will not be installed by default by this command, but which provides useful information including the human-readable vendor and product codes for detected hardware. It's not installed by default and not linked into the `usb` package by default because it adds ~400kb to the resulting binary. If you want both, they can be installed thus:
|
|
|
|
|
|
|
|
|
|
go get -v github.com/kylelemons/gousb/usb{,id}
|
|
|
|
|
go get -v github.com/google/gousb/usb{,id}
|
|
|
|
|
|
|
|
|
|
Notes for installation on Windows
|
|
|
|
|
---------------------------------
|
|
|
|
|
@@ -74,5 +74,5 @@ Documentation
|
|
|
|
|
=============
|
|
|
|
|
The documentation can be viewed via local godoc or via the excellent [godoc.org](http://godoc.org/):
|
|
|
|
|
|
|
|
|
|
- [usb](http://godoc.org/github.com/kylelemons/gousb/usb)
|
|
|
|
|
- [usbid](http://godoc.org/pkg/github.com/kylelemons/gousb/usbid)
|
|
|
|
|
- [usb](http://godoc.org/github.com/google/gousb/usb)
|
|
|
|
|
- [usbid](http://godoc.org/pkg/github.com/google/gousb/usbid)
|
|
|
|
|
|
Sebastian Zagrodzki