Merge pull request #42 from alejandro-colomar/master

Improve doc

1 files changed, 24 insertions, 34 deletions

diff --git a/README.rst b/README.rst
index 07c6fc3..a64e472 100644
--- a/README.rst
+++ b/README.rst
@@ -9,14 +9,16 @@ Prerequisites
 
 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).
+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)`_.
 
-.. _libalx: https://github.com/alejandro-colomar/libalx
-.. _debian: https://www.debian.org/devel/debian-installer/
-.. _Manjaro: https://manjaro.org/
-.. _Ubuntu: http://cdimage.ubuntu.com/daily-live/current/
+.. _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:
 --------------------------------------
@@ -25,16 +27,12 @@ Installing prerequisites on debian 11:
 
 	## install build tools:
 	$ sudo apt-get install gcc g++ 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
 
@@ -45,16 +43,12 @@ Installing prerequisites on manjaro:
 
 	## 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
-
 	## compile libalx
 	$ make base cv -C libalx -j8
-
 	## install libalx
 	$ sudo make install-base install-cv -C libalx -j2
 
@@ -65,9 +59,10 @@ Running the program
 compile:
 --------
 
-Before compiling you may want to modify the value of the macro ``dbg`` in the
-file ``src/dbg.h`` to some higher value to see some images and text of the
-process.  The value should be between 0 and 4, (values lower than 0 will act as
+Before compiling you may want to modify the value of the macros ``DBG`` and
+``DBG_SHOW_WAIT`` in the file ``src/dbg.h`` to some higher value to see some
+images and text of the process, and to be able to stop the program at each
+image.  The value should be between 0 and 4, (values lower than 0 will act as
 0, and values greater than 4 will act as 4).  The higher the value, the more
 debugging information.
 
@@ -75,15 +70,10 @@ debugging information.
 
 	## download the code:
 	$ git clone https://github.com/SMRLaundryApp/laundry-symbol-reader.git
-
-	## optional: clean the repository
-	$ make clean
-
 	## compile
-	$ make -j8
-
+	$ make -C laundry-symbol-reader -j8
 	## install
-	$ sudo make install -j2
+	$ sudo make install -C laundry-symbol-reader -j2
 
 run:
 ----
@@ -101,24 +91,24 @@ 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:
----------
+install:
+--------
 
 .. 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/bin/laundry-symbol-reader-dk
-	## Allow executing file as program:
-	$ chmod +x laundry-symbol-reader-dk
+	## clone the repository:
+	$ git clone https://github.com/SMRLaundryApp/laundry-symbol-reader.git
+	## install script
+	$ make inst-scripts -C laundry-symbol-reader
+	## remove the repository clone:
+	$ rm -rf laundry-symbol-reader
 
 run:
 ----
 
 .. code-block:: sh
 
-	$ ./laundry-symbol-reader-dk path/to/image
-
-The script can allso be installed in the system with ``make inst-scripts``.
+	$ laundry-symbol-reader-dk path/to/image