formward looking readme
This commit is contained in:
parent
b78f66e305
commit
cc6cf63ade
2
.gitignore
vendored
2
.gitignore
vendored
@ -1 +1 @@
|
||||
build
|
||||
site
|
||||
|
16
README.md
16
README.md
@ -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
|
||||
$ tool/build
|
||||
|
7
tool/build
Executable file
7
tool/build
Executable file
@ -0,0 +1,7 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
|
||||
tool/gofmt
|
||||
tool/measure
|
||||
tool/generate
|
Loading…
x
Reference in New Issue
Block a user