docs-matrix-spec/scripts/speculator/README
Richard van der Hoff 013b6db895 Add a note on building the speculator
... because the wiki says you need to read the README on how to build it.
2015-10-14 14:42:52 +01:00

14 lines
578 B
Text

speculator allows you to preview pull requests to the matrix.org specification.
It serves the following HTTP endpoints:
- / lists open pull requests
- /spec/123 which renders the spec as html at pull request 123.
- /diff/rst/123 which gives a diff of the spec's rst at pull request 123.
- /diff/html/123 which gives a diff of the spec's HTML at pull request 123.
To run it, you must install the `go` tool, and run:
`go run main.go`
To build the binary (which is necessary for deployment to the matrix.org
servers), you must again install `go`, and then run:
`go build`