summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Colomar <Colomar.6.4.3@GMail.com>2020-03-29 00:18:59 +0100
committerGitHub <noreply@github.com>2020-03-29 00:18:59 +0100
commit0f8ba5540369f0a00e7d66b0ddd3cff88356f79a (patch)
tree285d461ebda40dd8b7ffc529a963941d5c85f073
parent5e962ff6b9b04607c78e969e74b2031c0242a3cd (diff)
parentdbf2180bddae86ff0791d3b5fd9c3e8f1c07edb6 (diff)
Merge pull request #27 from alejandro-colomar/master
Simplify readme
-rw-r--r--README.rst32
1 files changed, 6 insertions, 26 deletions
diff --git a/README.rst b/README.rst
index 6c328c4..3631dad 100644
--- a/README.rst
+++ b/README.rst
@@ -98,43 +98,23 @@ If you don't have the system prerequisites above you can just run a docker
container with the program already installed.
This docker image is also used by the App.
The only drawback is that you don't have a display; the only output is text.
+There is a script to run the docker container easily.
download:
---------
.. code-block:: sh
+ ## download the latest docker image
$ docker image pull laundrysymbolreader/reader
+ ## download the script:
+ $ wget https://raw.githubusercontent.com/SMRLaundryApp/laundry-symbol-reader/master/laundry-symbol-reader-dk
+ ## Allow executing file as program:
+ $ chmod +x laundry-symbol-reader-dk
run:
-----
-
-There are two options: you can run the docker command directly, or you can
-run a script included in this repository (you need to download the script (or
-the full repository) for the second option).
-
-docker:
.......
.. code-block:: sh
- $ path=path/to/image
- $ dir=$(realpath $(dirname ${path}))
- $ fname=$(basename ${path})
- $ docker container run --tty --interactive \
- --volume ${dir}:${dir} \
- --env IMG_FNAME=${dir}/${fname} \
- laundrysymbolreader/reader
-
-script:
-.......
-
-.. code-block:: sh
-
- ## download the script:
- $ wget https://raw.githubusercontent.com/SMRLaundryApp/laundry-symbol-reader/master/laundry-symbol-reader-dk
- ## Allow executing file as program:
- $ chmod +x laundry-symbol-reader-dk
-
- ## run the script:
$ ./laundry-symbol-reader-dk path/to/image