Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (25 sloc) 1.1 KB

Contributing

Hub

Clone the project:

$ git clone https://github.com/dunglas/mercure

Install Gin for Live Reloading:

$ go get github.com/codegangsta/gin

Install the dependencies:

$ cd mercure
$ go get

Run the server:

$ gin run main.go

Go to http://localhost:3000 and enjoy!

To run the test suite:

$ go test -v -timeout 30s github.com/dunglas/mercure/hub

Protocol

The protocol is written in Markdown, compatible with Mmark. It is then converted in the the "xml2rfc" Version 3 Vocabulary.

To contribute to the protocol itself:

  • Make your changes
  • Download Mmark
  • Download xml2rfc using pip: pip install xml2rfc
  • Format the Markdown file: mmark -markdown -w spec/mercure.md
  • Generate the XML file: mmark spec/mercure.md > spec/mercure.xml
  • Validate the generated XML file and generate the text file: xml2rfc --text --v3 spec/mercure.xml
  • If appropriate, be sure to update the reference implementation accordingly
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.