From 5f384f5d357ab9014349f464a96d07c0aa93030a Mon Sep 17 00:00:00 2001 From: Tony Garnock-Jones Date: Tue, 11 Feb 2014 16:28:39 -0800 Subject: [PATCH] Minimal README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b63978 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# JS-Marketplace: a Network Calculus Implementation + +Currently just a prototype. + +Some of the examples are standalone (e.g. the textfield example); some +require a Racket server (e.g. the chat example). + +To install the Racket server: + + - download a [recent Racket](http://racket-lang.org/download/) (e.g. 5.93) + - when Racket is installed, install the `rfc6455` and `minimart` packages: + - `raco pkg install rfc6455` + - `raco pkg install minimart` + +To run the Racket server: + + - `racket server.rkt` from the base directory of this repository. + +The Racket server listens for tunnelled Network Calculus events via +websocket on ports 8000 (HTTP) and 8443 (HTTPS, if you have a +certificate available). + +Note that if you *don't* have a certificate available, then you will +see complaints from the Racket server as it starts. These end up just +being warnings, despite the severity of their appearance; the server +should function normally on port 8000.