brmlab/brmbar-github
4
0
Fork 1
mirror of https://github.com/brmlab/brmbar.git synced 2025-06-09 05:44:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

USAGE: Adding users, what about reinventorization?

Browse source
This commit is contained in:
Petr Baudis 2013-02-10 17:56:01 +01:00
parent 13bc4d6f60
commit 55e6a5226c
2 changed files with 27 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
brmbar3/INSTALL.md
View file

@ -24,7 +24,7 @@ Hardware Requirements
accounts; these will be then used by people to buy stuff using their accounts; these will be then used by people to buy stuff using their
accounts - first scan barcode of the item, then scan your barcode, accounts - first scan barcode of the item, then scan your barcode,
voila. Scanning your barcode directly can bring the user to a screen 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 Software Requirements
--------------------- ---------------------
@ -56,6 +56,8 @@ Software Setup
If you want to make sure all works as expected, execute the SQL If you want to make sure all works as expected, execute the SQL
statements in file `SQL.test` (revisit for currency names too) which statements in file `SQL.test` (revisit for currency names too) which
will populate the database with a bit of sample data for testing. 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. TODO: Mention the actual commands to execute.

24
brmbar3/USAGE.md
View file

@ -5,6 +5,8 @@ Quick Guide
money into the cash box. money into the cash box.
* I want to buy from credit: I scan item's barcode, then my barcode. * 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, * 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. 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 To enter text (or numbers too), you can use both the on-screen keyboard
and the physical keyboard nearby. 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).