Mercurial > hg > index.cgi

diff README @ 0:bef2801ac83e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial checkin with reference implementation of core protocol Initial checkin. Has the initial version of the protocol documentation along with a reference implementation of the core protocol.
author William Astle <lost@l-w.ca>
date Sun, 08 May 2016 12:56:39 -0600
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun May 08 12:56:39 2016 -0600
@@ -0,0 +1,10 @@
+The docs/ folder contains protocol documentation for lwwire.
+
+The src/ folder contains a reference protocol implementation. This is NOT
+intended for casual users. It is meant to serve as an illustration of how
+the protocol can be implemented and serves as a means to test features. The
+reference implementation does not contain a fancy GUI, configuration file
+handler, or even serial or TCP port handling. It simply operates the
+protocol on stdin and stdout and prints diagnostics to stderr. A tool like
+socat can be used to link it to a TCP port. Similar tools might be used to
+link it to a serial port.