Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.

Commit

Permalink
Add note that this repository is obsolete
Browse files Browse the repository at this point in the history
  • Loading branch information
maruel committed May 29, 2021
1 parent c5a4b83 commit 679f489
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 77 deletions.
28 changes: 2 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,7 @@
# periph extra!

[![mascot](https://raw.githubusercontent.com/periph/website/master/site/static/img/periph-mascot-280.png)](https://periph.io/)

Supplemental tools for [periph.io/x/periph](https://periph.io/x/periph) that
cannot live there. It may be because the tool/library:

- depends on external packages
- uses cgo

[![Go Report Card](https://goreportcard.com/badge/periph.io/x/extra)](https://goreportcard.com/report/periph.io/x/extra)
[![Coverage Status](https://codecov.io/gh/periph/extra/graph/badge.svg)](https://codecov.io/gh/periph/extra)
[![Build Status](https://travis-ci.org/periph/extra.svg)](https://travis-ci.org/periph/extra)
[![Gitter chat](https://badges.gitter.im/google/periph.png)](https://gitter.im/periph-io/Lobby)


## Install

Install the whole suite with `periphextra` enabled to have access to the full
functionality:

```
go get -u periph.io/x/extra/cmd/...
go install -tags periphextra periph.io/x/periph/cmd/...
```

See https://periph.io for more details.

This repository is obsolete.
Please use https://periph.io/x/host/v3 (or later) directly.

## Authors

Expand Down
4 changes: 2 additions & 2 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.

// Package extra is for documentation only.
// Package extra is obsolete.
//
// For for help, see https://github.com/periph/extra/tree/master/README.md
// Please use https://periph.io/x/host/v3 (or later) directly.
package extra
30 changes: 1 addition & 29 deletions experimental/hostextra/usbbus/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,5 @@
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.

// Package usbbus implements OS specific functions for conn/usb.
//
// This includes handling the connected devices on process startup and handling
// of the connection events.
//
// This package is only built with the build tag 'usb' because it causes a
// dependency on https://github.com/kylelemons/gousb. This package uses cgo that
// depends on libusb being installed. This is generally not the case by
// default, so it causes a go get failure which is really obnoxious to users.
//
// Debian
//
// This includes Raspbian and Ubuntu.
//
// First configure cgo as explained at https://periph.io/x/extra#hdr-Debian.
//
// You need to install libusb-1.0:
//
// sudo apt install libusb-1.0-0-dev
//
// MacOS
//
// First configure cgo as explained at https://periph.io/x/extra#hdr-MacOS.
//
// brew install libusb
//
// Windows
//
// The package is currently disabled on Windows.
// Package usbbus never worked and is obsolete.
package usbbus
16 changes: 2 additions & 14 deletions hostextra/d2xx/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,7 @@
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.

// Package d2xx is a cgo wrapper for the FTDI d2xx drive.
// Package d2xx is obsolete.
//
// The supported devices (ft232h/ft232r) implement support for various
// protocols like the GPIO, I²C, SPI, UART, JTAG.
//
// More details
//
// See https://periph.io/device/ftdi/ for more details, and how to configure
// the host to be able to use this driver.
//
// Datasheets
//
// http://www.ftdichip.com/Support/Documents/DataSheets/ICs/DS_FT232R.pdf
//
// http://www.ftdichip.com/Support/Documents/DataSheets/ICs/DS_FT232H.pdf
// Please use https://periph.io/x/host/v3 (or later) directly.
package d2xx
8 changes: 2 additions & 6 deletions hostextra/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.

// Package hostextra defines the extra drivers for the host itself.
// Package hostextra is obsolete.
//
// The host is the machine where this code is running.
//
// Subpackages contain the drivers that are loaded automatically. Contrary to
// periph.io/x/periph/host, hostextra loads drivers that depends on either third
// party Go packages and/or on cgo.
// Please use https://periph.io/x/host/v3 (or later) directly.
package hostextra

0 comments on commit 679f489

Please sign in to comment.