summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 12 insertions, 25 deletions
diff --git a/README.rst b/README.rst
index 1688e77..ef95017 100644
--- a/README.rst
+++ b/README.rst
@@ -11,13 +11,10 @@ The program depends on libalx-base and libalx-cv (both from libalx_) being
installed in the system, and those libraries depend on some other packages
being installed in the system. For those reasons, I recommend
`debian 11 (bullseye)`_ as the operating system. That's the OS used in the
-`docker image`_. Other compatible OSes include: Manjaro_,
-`Ubuntu 20.04 (focal)`_.
+`docker image`_.
.. _libalx: https://github.com/alejandro-colomar/libalx
.. _`debian 11 (bullseye)`: https://www.debian.org/devel/debian-installer/
-.. _Manjaro: https://manjaro.org/
-.. _`Ubuntu 20.04 (focal)`: http://cdimage.ubuntu.com/daily-live/current/
.. _`docker image`: https://hub.docker.com/r/laundrysymbolreader/reader
Installing prerequisites on debian 11:
@@ -26,27 +23,13 @@ Installing prerequisites on debian 11:
.. code-block:: sh
## install build tools:
- $ sudo apt-get install gcc g++ make git pkg-config
+ $ sudo apt-get install gcc gcc-10 g++ g++-10 make git pkg-config
## install libraries which libalx depends on:
$ sudo apt-get install libbsd-dev libgsl-dev libopencv-dev
## download libalx
- $ git clone https://github.com/alejandro-colomar/libalx.git
- ## compile libalx
- $ make base cv -C libalx -j8
- ## install libalx
- $ sudo make install-base install-cv -C libalx -j2
-
-Installing prerequisites on manjaro:
---------------------------------------
-
-.. code-block:: sh
-
- ## install build tools:
- $ sudo pacman -S gcc make git pkgconf
- ## install libraries which libalx depends on:
- $ sudo pacman -S libbsd gsl opencv
- ## download libalx
- $ git clone https://github.com/alejandro-colomar/libalx.git
+ $ git clone \
+ --single-branch --branch v1.0-b23 \
+ https://github.com/alejandro-colomar/libalx.git
## compile libalx
$ make base cv -C libalx -j8
## install libalx
@@ -69,7 +52,9 @@ debugging information.
.. code-block:: sh
## download the code:
- $ git clone https://github.com/SMRLaundryApp/laundry-symbol-reader.git
+ $ git clone \
+ --single-branch --branch v1.1 \
+ https://github.com/SMRLaundryApp/laundry-symbol-reader.git
## compile
$ make -C laundry-symbol-reader -j8
## install
@@ -96,9 +81,11 @@ install:
.. code-block:: sh
## download the latest docker image
- $ docker image pull laundrysymbolreader/reader
+ $ docker image pull laundrysymbolreader/reader:v1.1
## clone the repository:
- $ git clone https://github.com/SMRLaundryApp/laundry-symbol-reader.git
+ $ git clone \
+ --single-branch --branch v1.1 \
+ https://github.com/SMRLaundryApp/laundry-symbol-reader.git
## install script
$ sudo make inst-scripts -C laundry-symbol-reader
## remove the repository clone: