matrix-doc

History

Richard van der Hoff 8aa0f64665 Update the speculator to understand spec subdirs Fix the speculator so that it doesn't blow up when it finds subdirs in the gen directory. (It doesn't handle the html diff very well in the case that the subdirs don't match, but it's hard to do much about that)		2016-05-05 18:46:29 +01:00
..
README	Cache spec output	2015-10-26 10:28:14 +00:00
htmldiff.pl	speculator: Add HTML diffing	2015-09-14 11:03:54 +01:00
main.go	Update the speculator to understand spec subdirs	2016-05-05 18:46:29 +01:00

README

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.

The build or run, you need a working `go` installation.
Then fetch dependencies:
 ` go get github.com/hashicorp/golang-lru`

To run it, then 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 dependencies, and then run:
 `go build`