summaryrefslogtreecommitdiffstats
path: root/docker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..065bacf
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,26 @@
+# Install
+
+Create the docker image with:
+```bash
+docker build -t sbs-build .
+```
+
+# Config
+
+Change (or create) the `ktt-shopsystem.cfg` file that everything lays in `/mnt/serial-barcode-scanner` (change every folder...).
+
+
+# Usage
+
+Run the image with:
+```bash
+# change into the "serial-barcode-scanner" directory
+cd ..
+
+docker run --rm -it -p 8080:8080 -v "$PWD":/mnt/serial-barcode-scanner sbs-build
+```
+
+You have now a tmux terminal to work with the vala files and run the program. E.g.
+- `cd src && make` to make the whole project
+- `cd src/curses-ui/ && ./curses-ui` to start the curses ui.
+- ...