annotate README @ 16:13be9d3a6927 default tip

update doc to include transactional delay requirement
author Brett Gordon
date Tue, 13 Dec 2016 10:42:01 -0500
parents bef2801ac83e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
1 The docs/ folder contains protocol documentation for lwwire.
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
2
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
3 The src/ folder contains a reference protocol implementation. This is NOT
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
4 intended for casual users. It is meant to serve as an illustration of how
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
5 the protocol can be implemented and serves as a means to test features. The
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
6 reference implementation does not contain a fancy GUI, configuration file
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
7 handler, or even serial or TCP port handling. It simply operates the
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
8 protocol on stdin and stdout and prints diagnostics to stderr. A tool like
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
9 socat can be used to link it to a TCP port. Similar tools might be used to
bef2801ac83e Initial checkin with reference implementation of core protocol
William Astle <lost@l-w.ca>
parents:
diff changeset
10 link it to a serial port.