matrix-spec

mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00

History

Richard van der Hoff d1d3d27e2f Merge pull request #216 from matrix-org/rav/fix_speculator_redirects Add a host and scheme to Location headers in redirects		2015-12-07 10:26:38 +00:00
..
htmldiff.pl	speculator: Add HTML diffing	2015-09-14 11:03:54 +01:00
main.go	Merge pull request #216 from matrix-org/rav/fix_speculator_redirects	2015-12-07 10:26:38 +00:00
README	Cache spec output	2015-10-26 10:28:14 +00: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`