Tryanks/gousb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README [skip ci]

Browse Source
This commit is contained in:
Kyle Lemons
2016-04-03 10:38:12 -07:00
parent 1b4ec4416e
commit 9397824026
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,6 +1,9 @@
Introduction Introduction
============ ============
[![Build Status][ciimg]][ci]
[![GoDoc][docimg]][doc]
The gousb package is an attempt at wrapping the libusb library into a Go-like binding. The gousb package is an attempt at wrapping the libusb library into a Go-like binding.
Supported platforms include: Supported platforms include:
@@ -9,14 +12,20 @@ Supported platforms include:
- darwin - darwin
- windows - windows
[ciimg]: https://travis-ci.org/kylelemons/gousb.svg?branch=master
[ci]: https://travis-ci.org/kylelemons/gousb
[docimg]: https://godoc.org/github.com/kylelemons/gousb?status.svg
[doc]: https://godoc.org/github.com/kylelemons/gousb
Contributing Contributing
============ ============
Because I am a Google employee, contributing to this project will require signing the [Google CLA](https://developers.google.com/open-source/cla/individual?csw=1). Because I am a Google employee, 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 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. 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 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. so that I can verify that it is on file before I can accept pull requests.
[cla]: https://cla.developers.google.com/
Installation on Linux Installation on Linux
===================== =====================
@@ -47,6 +56,7 @@ There is also a `usbid` package that will not be installed by default by this co
Installation on Windows Installation on Windows
======================= =======================
Dependencies Dependencies
------------ ------------
- Gcc (only tested on [Win-Builds](http://win-builds.org/), but any MSYS, CYGWIN, MINGW should be worked - Gcc (only tested on [Win-Builds](http://win-builds.org/), but any MSYS, CYGWIN, MINGW should be worked
@@ -83,7 +93,7 @@ Then install `gousb`:
Documentation Documentation
============= =============
The documentation can be viewed via local godoc or via Gary Burd's excellent [godoc.org](http://godoc.org/): 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) - [usb](http://godoc.org/github.com/kylelemons/gousb/usb)
- [usbid](http://godoc.org/pkg/github.com/kylelemons/gousb/usbid) - [usbid](http://godoc.org/pkg/github.com/kylelemons/gousb/usbid)