From 6db21153c2e7c4886efa19bb4b0478b6386992f7 Mon Sep 17 00:00:00 2001
From: Mark Tearle <mark@tearle.com>
Date: Sat, 14 Mar 2015 22:55:49 +0800
Subject: [PATCH] Update TODO with usage instructions
---
README.md | 13 ++++++++-----
TODO | 2 +-
2 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 6f3d01a..f45c4d9 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,20 @@ Usage
virtualcoke.py
Via the network:
- FIXME
+ When run, virtualcoke attempt to bind to port 502 (Modbus standard port)
+ If this fails, it will bind to port 1502
+ To bind to the lower port, you may need to be a privileged user
Via the console:
- Keypad numbers (0-6) mimic front buttons of coke machine
- FIXME
-
+ Keypad numbers (0-6) mimic front buttons of the coke machine
+ Keypad numbers (7-9, M) mimic the interior buttons of the coke machine
+ ^Q exits the simulator cleanly
Requirements
-------------
-* npyscreen 4.6.1 or later
+* npyscreen 4.8.5 or later
+* Twisted
Known Issues
-------------
diff --git a/TODO b/TODO
index c7dbebc..4f37ebc 100644
--- a/TODO
+++ b/TODO
@@ -7,6 +7,6 @@ DONE Hidden other buttons
DONE Hook up modbus
DONE Test against dispense
DONE Modbus alternative port
+DONE Write up documentation
Coin Return Button
- Write up documentation
--
GitLab