Skip to content

Commit

Permalink
Update import paths in the documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hajimehoshi committed Oct 3, 2020
1 parent 8b81795 commit e90b5ff
Showing 4 changed files with 16 additions and 24 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -39,7 +39,7 @@ You don't have to update existing files' license comments.
// +build example jsgo
```

`example` is to prevent from installing executions by `go get github.com/hajimehoshi/ebiten/...`.
`example` is to prevent from installing executions by `go get github.com/hajimehoshi/ebiten/v2/...`.

`jsgo` is to make the examples work on [jsgo.io](https://jsgo.io/).

22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ebiten

[![PkgGoDev](https://pkg.go.dev/badge/github.com/hajimehoshi/ebiten)](https://pkg.go.dev/github.com/hajimehoshi/ebiten)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/hajimehoshi/ebiten/v2)](https://pkg.go.dev/github.com/hajimehoshi/ebiten)
[![Build Status](https://github.com/hajimehoshi/ebiten/workflows/test/badge.svg)](https://github.com/hajimehoshi/ebiten/actions?query=workflow%3Atest)
[![Build Status](https://travis-ci.org/hajimehoshi/ebiten.svg?branch=master)](https://travis-ci.org/hajimehoshi/ebiten)
[![Go Report Card](https://goreportcard.com/badge/github.com/hajimehoshi/ebiten)](https://goreportcard.com/report/github.com/hajimehoshi/ebiten)
@@ -10,7 +10,7 @@
Ebiten is an open source game library for the Go programming language. Ebiten's simple API allows you to quickly and easily develop 2D games that can be deployed across multiple platforms.

* [Website (ebiten.org)](https://ebiten.org)
* [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten)
* [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
* [Cheat Sheet](https://ebiten.org/documents/cheatsheet.html)

![Overview](https://ebiten.org/images/overview1.12.png)
@@ -39,15 +39,15 @@ For installation on desktops, see [the installation instruction](https://ebiten.

## Packages

* [ebiten](https://pkg.go.dev/github.com/hajimehoshi/ebiten)
* [audio](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio)
* [mp3](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/mp3)
* [vorbis](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/vorbis)
* [wav](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/wav)
* [ebitenutil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/ebitenutil)
* [inpututil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/inpututil)
* [mobile](https://pkg.go.dev/github.com/hajimehoshi/ebiten/mobile)
* [text](https://pkg.go.dev/github.com/hajimehoshi/ebiten/text)
* [ebiten](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
* [audio](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio)
* [mp3](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/mp3)
* [vorbis](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/vorbis)
* [wav](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/wav)
* [ebitenutil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/ebitenutil)
* [inpututil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/inpututil)
* [mobile](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/mobile)
* [text](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/text)

## Community

10 changes: 1 addition & 9 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -3,17 +3,9 @@
## Desktops

```sh
go run -tags=example $GOPATH/src/github.com/hajimehoshi/ebiten/examples/rotate/main.go
go run -tags=example github.com/hajimehoshi/ebiten/examples/rotate
```

## Web Browsers

```sh
gopherjs serve --tags=example
```

and access `http://127.0.0.1:8080/github.com/hajimehoshi/ebiten/examples`.

## Android

Install [gomobile](https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile) first.
6 changes: 3 additions & 3 deletions internal/graphicsdriver/metal/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
These packages are copied from Dmitri Shuralyov's mtl packages and edited with Dmitri's permission:

* `github.com/hajimehoshi/ebiten/internal/graphicsdriver/metal/ca` (copied from `dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ca`)
* `github.com/hajimehoshi/ebiten/internal/graphicsdriver/metal/mtl` (copied from `dmitri.shuralyov.com/gpu/mtl`)
* `github.com/hajimehoshi/ebiten/internal/graphicsdriver/metal/ns` (copied from `dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ns`)
* `github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/ca` (copied from `dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ca`)
* `github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/mtl` (copied from `dmitri.shuralyov.com/gpu/mtl`)
* `github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/ns` (copied from `dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ns`)

0 comments on commit e90b5ff

Please sign in to comment.