From e90b5ff277f7ac21ae2eb96772c86be8f47bd220 Mon Sep 17 00:00:00 2001 From: Hajime Hoshi Date: Sun, 4 Oct 2020 05:07:08 +0900 Subject: [PATCH] Update import paths in the documents --- CONTRIBUTING.md | 2 +- README.md | 22 +++++++++++----------- examples/README.md | 10 +--------- internal/graphicsdriver/metal/README.md | 6 +++--- 4 files changed, 16 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad974aff3..ee8252385 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/). diff --git a/README.md b/README.md index dd5fd0986..ff0d1a9a0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/examples/README.md b/examples/README.md index 724dd148b..db4167574 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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. diff --git a/internal/graphicsdriver/metal/README.md b/internal/graphicsdriver/metal/README.md index b543f6538..c28e02808 100644 --- a/internal/graphicsdriver/metal/README.md +++ b/internal/graphicsdriver/metal/README.md @@ -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`)