Updated README after changes on this branch

This commit is contained in:
Miguel M 2023-06-06 18:36:19 +01:00
parent b60644eecc
commit 2f2c65d360
1 changed files with 9 additions and 3 deletions

12
README
View File

@ -22,7 +22,12 @@ scripts. The main executable can be compiled by running the corresponding
python3 make.py link
This will produce a main.exe executable in the root directory.
This will produce a DEBUG [main.debug.exe] executable in the root directory.
If a RELEASE environment variable is set, a RELEASE [main.release.exe]
executable is produced instead, i.e., to produce a release executable, run:
RELEASE=1 python3 make.py link
See all available recipes by running
python3 make.py --list
@ -34,9 +39,10 @@ and read more about [sane]: at https://github.com/mikeevmm/sane.
To use, pipe the input (structured according to the source specification) into
the executable, while specifying the number of outputs and inputs, in that
order. E.g.,
order, followed by a bin size (see the following section for details on the
meaning of the bin size). E.g.,
./main.exe 2 2 2 2 < data/2222_inq.txt
./main.release.exe 2 2 2 2 48 < data/2222_inq.txt
[[Notes on the Approach Taken]]