WIP: Code Review

Misc

• Add newline at end of file everywhere

README.md

• Link to RUNME.sh wrong
• Code fences should be ```bash
• Add "Getting Started" section (or similar)
  • Document what to do to run the experiments,
  • which output files to expect, and
  • how to interpret those (or how to build the paper).
  • Keep (detailed) build instructions separate

Dockerfile

• This warning occurred a couple of times when building with podman version 3.4.7 ... do you really need bash over sh?

  WARN[0003] SHELL is not supported for OCI image format, [/bin/bash -c] will be ignored. Must use `docker` format 

  Update: podman builds fine without it

• Out of curiosity: is it necessary to create a new user inside the container? I like the ARG USER_UID etc, such that users can configure their id -u etc.

• while sleep 1000; do :; done looks fishy and useless ... why don't you use a plain /bin/bash?

• Remove SHELL ["/bin/bash", "-c"]

• Consider adding the sources and build instructions to Dockerfile

RUNME.sh

• Consider removing cmake stuff
• Replace cd demos/DEMO; ...; cd ../../ blocks with pushd demos/DEMO; ...; popd (optional: {pushd,popd} > /dev/null)
• Replace .build by $BUILD_DIR or similar
• Fix echo messages; they are all the same
• Ensure BUILD_DIR matches value given in README
• Allow user to overwrite defaults; add e.g. echo Using build directory ${BUILD_DIR:=some_default} etc.