| contrib | ||
| lib | ||
| plugins | ||
| t | ||
| .gitignore | ||
| INSTALLING.md | ||
| LICENSE | ||
| README.md | ||
| revbank | ||
| revbank.accounts | ||
| revbank.market | ||
| revbank.plugins | ||
| revbank.products | ||
| UPGRADING.md | ||
revbank - Banking for hackerspace visitors
Installing RevBank
For new installations, refer to INSTALLING.md.
Upgrading RevBank
When upgrading from a previous version, please refer to the file UPGRADING.md because there might be incompatible changes that require your attention.
Using RevBank (for end users)
Type help.
Exiting revbank
Exiting is not supported because it's designed to run continuously on its main
terminal. But if you run it from a shell, you can probably stop it using ctrl+Z
and then kill the process (e.g. kill %1). RevBank does not keep any files
open, so it's safe to kill when idle.
Documentation
End-user documentation is provided through the help command. For RevSpace
visitors, some additional end-user documentation is available in Dutch at
https://revspace.nl/RevBank.
RevBank can be used without RTFM, but some documentation is provided to describe the inner workings in more detail:
- RevBank - technical overview
- RevBank::Amount - fixed decimal numbers
- RevBank::FileIO - reading and writing files
- RevBank::Global - constants and utility functions
- RevBank::Plugins - writing plugins
- RevBank::Products - revbank.products file format
- RevBank::TextEditor - internal pager and editor
- RevBank::Users - user accounts and special accounts
The plugins are mostly undocumented, but some have useful hints in the source files, and some have actual documentation:
Note: internal links between POD files are all broken in GitHub's rendering, because GitHub wrongly assumes that every Perl package lives on CPAN.