From 55e6a5226c506ac465db6c0f341b6c1927d8f492 Mon Sep 17 00:00:00 2001 From: Petr Baudis Date: Sun, 10 Feb 2013 17:56:01 +0100 Subject: [PATCH] USAGE: Adding users, what about reinventorization? --- brmbar3/INSTALL.md | 4 +++- brmbar3/USAGE.md | 24 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/brmbar3/INSTALL.md b/brmbar3/INSTALL.md index cdff5c4..f7207c6 100644 --- a/brmbar3/INSTALL.md +++ b/brmbar3/INSTALL.md @@ -24,7 +24,7 @@ Hardware Requirements accounts; these will be then used by people to buy stuff using their accounts - first scan barcode of the item, then scan your barcode, voila. Scanning your barcode directly can bring the user to a screen - where they can see their credit and charge it too. + where they can see their credit and charge it too. See also USAGE. Software Requirements --------------------- @@ -56,6 +56,8 @@ Software Setup If you want to make sure all works as expected, execute the SQL statements in file `SQL.test` (revisit for currency names too) which will populate the database with a bit of sample data for testing. +* Regarding adding users at this point and for other usage instructions, + refer to the USAGE file. TODO: Mention the actual commands to execute. diff --git a/brmbar3/USAGE.md b/brmbar3/USAGE.md index b20d428..b2526c7 100644 --- a/brmbar3/USAGE.md +++ b/brmbar3/USAGE.md @@ -5,6 +5,8 @@ Quick Guide money into the cash box. * I want to buy from credit: I scan item's barcode, then my barcode. +(If you don't have your barcode printed out, you can also type your +username on a physical keyboard.) * I want to put money on credit: press **Charge**, I scan my barcode, type some amount, press **Charge** and put money in the cash box. @@ -50,3 +52,25 @@ there are no irregularities. To enter text (or numbers too), you can use both the on-screen keyboard and the physical keyboard nearby. + + +Administrative Usage +-------------------- + +* The most common administrative action you will need to do is adding + new user (also called debt or credit) accounts. The GUI support for + this is not implemented yet, but the `brmbar-cli.py` UI allows it: + + ./brmbar-cli.py adduser joehacker + + Afterwards, print out a barcode saying "joehacker" and stick that + somewhere nearby; scanning that barcode will allow access to this + account (and so will typing "joehacker" on a physical keyboard). + +* If your inventory stock count or cash box amount does not match +the in-system data, you will need to make a corrective transaction. +In the future, brmbar-cli.py will support this, but there is no +implementation yet; it's not entirely clear yet what is the proper +way to do this from the accounting standpoint. In the meantime, you +can use SQL INSERTs to manually create a transaction with appropriate +transaction splits (see doc/architecture for details on splits).