Browse Source

Add README.adoc

Signed by: p <> GPG Key ID: A0420B94F92B9493
1 changed files with 49 additions and 0 deletions
  1. +49

+ 49
- 0
README.adoc View File

@@ -0,0 +1,49 @@

'sklad' is a simple personal warehouse management system or, let's rather say,
"stuff management system", employing a web UI for easy mobile access from
a smartphone. The templates are currently localised only in the Czech language.

The project also contains reusable Go packages with a Brother QL-series USB
printer driver and a simple BDF bitmap font renderer, as well as a few related
utilities for previewing, printing and debugging.

Building and Running
Build dependencies: Go +
Runtime dependencies: Linux, a Brother QL label printer connected over USB

$ go get -u

You will need to bootstrap the database by writing a minimal 'db.json':
"Password": "login-password",
"Prefix": "A",
"BDPPath": "font.bdf",
"BDFScale": 3

Decent Unicode fonts in the BDF format can be obtained from
though they will need some upscaling because of the printer's high DPI.

After placing the templates and the BDF font file in the current working
directory, run the application as follows:

$ sklad :8000 db.json

Contributing and Support
Use to report any bugs, request features,
or submit pull requests. `git send-email` is tolerated. If you want to discuss
the project, feel free to join me at ircs://, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.