From cf5bf94d47e0a77a6a268652d22a5ded85a49106 Mon Sep 17 00:00:00 2001 From: Hajime Hoshi Date: Tue, 6 Jan 2015 10:31:00 +0900 Subject: [PATCH] Simplify readme --- readme.md | 72 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 69 deletions(-) diff --git a/readme.md b/readme.md index 45e692c51..051f725e6 100644 --- a/readme.md +++ b/readme.md @@ -15,76 +15,10 @@ * 2D Graphics * Input (Mouse, Keyboard) -## Example +## Documentation -* example/blocks - Puzzle game you know -* example/hue - Changes the hue of an image -* example/mosaic - Mosaics an image -* example/perspective - See an image in a perspective view -* example/rotate - Rotates an image -* etc. - -## Install on Mac OS X - -``` -:; brew install glew -:; brew install glfw3 # or homebrew/versions/glfw3 -:; go get -u github.com/hajimehoshi/ebiten -``` - -If you want to use GopherJS, execute this: - -``` -:; go get -u -tag=js github.com/hajimehoshi/ebiten -``` - -## Execute the example - -``` -:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/example -:; go run blocks/main.go -``` - -## Execute the example on a web browser - -``` -:; go get github.com/gopherjs/gopherjs -:; go run $GOPATH/src/github.com/hajimehoshi/ebiten/example/server/main.go -``` - -Then, open ``localhost:8000`` on your browser. - -``localhost:8000/?EXAMPLE_NAME`` shows other examples (e.g. ``localhost:8000/?rotate``). - -## Run your game on a web browser - -Compile your game with GopherJS: - -``` -:; go get github.com/gopherjs/gopherjs -:; gopherjs build -o yourgame.js path/to/yourgame -``` - -Then, open the below HTML on your HTTP server: - -```html - - -``` - -### Benchmark the example - -``` -:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/example -:; go build -o=example blocks/main.go -:; ./example -cpuprofile=cpu.out -:; go tool pprof ./example cpu.out -``` - -## Versioning - -* We obey [Semantic Versioning](http://semver.org/) basically. +http://hajimehoshi.github.io/ebiten/ ## License -See license.txt. +Ebiten is licensed under Apache license version 2.0. See license.txt.