mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-09-20 13:22:19 +02:00
Code Issues Packages Projects Releases Wiki Activity
de1bb1b392
ebiten/_docs
History
Hajime Hoshi 1cb66048ad doc: go generate; Add style.css
2016-08-26 23:33:36 +09:00
..
public doc: go generate; Add style.css 2016-08-26 23:33:36 +09:00
server doc: Improve server 2016-08-02 00:51:37 +09:00
.gitignore Bug fix: example -> examples in doc 2016-02-13 23:02:54 +09:00
example.tmpl.html docs: Add <title> to examples 2015-01-09 03:29:59 +09:00
examplecontent.tmpl.html doc: Bug fix: Don't specify http or https (#150) 2016-02-15 11:35:05 +09:00
gen.go doc: Bug fix: add build tag 'example' 2016-08-26 23:33:17 +09:00
generate.go doc: Regenerate 2016-02-21 05:40:56 +09:00
index.tmpl.html doc: go generate; Add style.css 2016-08-26 23:33:36 +09:00
README.md doc: Update README 2016-04-23 02:12:51 +09:00

README.md

How to generate the doc

go generate .

How to run HTTP server

go run server/main.go

How to deploy

git subtree push --prefix _docs/public/ origin gh-pages

If the above doesn't work, try this:

# https://gist.github.com/cobyism/4730490#gistcomment-1394421
git subtree split --prefix _docs/public -b gh-pages
git push -f origin gh-pages:gh-pages
git branch -D gh-pages

How to update the version

  1. Fix the release date in the HTML
  2. Create a new branch from master branch with a version name like 1.2
  3. In master branch:
  4. Update version.txt in the master branch like 1.3.0-alpha
  5. In the new branch:
  6. Update version.txt like 1.2.0-rc1
  7. Generate the doc
  8. Add tag like v1.2.0-rc1
  9. Deploy JavaScript files to github.com/hajimehoshi/ebiten.pagestorage
  10. Deploy the doc