yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

formward looking readme

Browse Source
This commit is contained in:
Mark McGranaghan 2012-10-09 07:47:56 -07:00
parent b78f66e305
commit cc6cf63ade
3 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1 +1 @@
build site

16
README.md
View File

@ -1,8 +1,18 @@
## gbe-book ## gobyexample
Go by Example book source and build toolchain. Source for the [Go by Example](https://mmcgrana.github.com/gobyexample/)
documentation project.
### Usage
### Generation
The web site is generated from `.go` and `.md` source
files using a custom site generator.
Generation requires the [`pygmentize`](http://pygments.org/)
binary for syntax highlighting.
To generate and view the site:
```console ```console
$ tool/build $ tool/build

7
tool/build Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
set -e
tool/gofmt
tool/measure
tool/generate