Minor updates to documentation and versioning

ACKNOWLEDGMENTS.md

@@ -5,7 +5,7 @@
 Alexander Mordvintsev, Christopher Olah, and Mike Tyka. Google AI Blog, 2015-06-17. \
 https://ai.googleblog.com/2015/06/inceptionism-going-deeper-into-neural.html
 
-## Cook-a-Dream is based on Tensorflow tutorials:
+## Cook-a-Dream is based on TensorFlow tutorials:
 https://www.tensorflow.org/tutorials/generative/deepdream \
 https://www.tensorflow.org/tutorials/generative/style_transfer
 
@@ -14,7 +14,7 @@ https://www.tensorflow.org/tutorials/generative/style_transfer
 > http://www.apache.org/licenses
 
 ## The noisy image generator and the ReLU warmup procedure are based on:
-https://github.com/tensorflow/lucid
+https://github.com/TensorFlow/lucid
 
 > Apache License\
 > Version 2.0, January 2004\
@@ -28,12 +28,13 @@ https://distill.pub/2017/feature-visualization/
 Feature visualization is the earnest sibling to light-hearted deep dreaming, but the implementation techniques are surprisingly similar.
 
 ## In the course of developing this program, the author found the following tutorial helpful:
-The idea of blending the octaves with the original image was based on this example.
 
 "Deep Dream with TensorFlow: A Practical guide to build your first Deep Dream Experience" \
 Naveen Manwani. Hackernoon, 2018-12-27. \
 https://hackernoon.com/deep-dream-with-tensorflow-a-practical-guide-to-build-your-first-deep-dream-experience-f91df601f479
 
+The idea of blending the octaves with the original image was based on this example.
+
 # Main software components
 
 ## The GUI of Cook-a-Dream is implemented with Qt 6.2.2
@@ -98,6 +99,10 @@ https://www.python.org/
 > Python software and documentation are licensed under the PSF License Agreement.\
 > https://docs.python.org/3/license.html
 
+## MenuFit.qml
+
+The auto-sizing code for QML native menus is adapted from [this blog post by Martin Hoeher](https://martin.rpdev.net/2018/03/13/qt-quick-controls-2-automatically-set-the-width-of-menus.html), who has kindly released his solution to public domain.
+
 # Other components
 
 ## Roboto Typeface

README.md

@@ -1,6 +1,6 @@
 <img src="README.png" alt="Cook-a-Dream Header" style="width: 100%;"/>
 
-Cook-a-Dream wraps an interactive, user-friendly interface around [deep dreaming](https://ai.googleblog.com/2015/06/inceptionism-going-deeper-into-neural.html). It aims to unleash the creative and [pedagogical](https://distill.pub/2017/feature-visualization/) potentials of deep dreaming for non-technical users.
+Cook-a-Dream wraps an interactive, user-friendly interface around [deep dreaming](https://ai.googleblog.com/2015/06/inceptionism-going-deeper-into-neural.html). It aims to unleash the creative and [pedagogic](https://distill.pub/2017/feature-visualization/) potentials of deep dreaming for non-technical users.
 
 Deep Dreaming uses Artificial Intelligence to create or modify images. It optimizes images to “superexcite” certain parts of an artificial neural network specialized in recognizing categories of objects. The process compares to dreaming, or maybe to visual hallucinations in humans.
 
@@ -86,7 +86,7 @@ TensorFlow is officially supported on Ubuntu 16.04 or later, but users report su
 
 	```python cookadream/cookadream.py```
 
-We tested Cook-a-Dream on an Ubuntu 20.04.3 server with acceleration with NVIDIA TITAN Xp GPUs. In our tests, we ran Cook-a-Dream remotely, using [X11 forwarding](https://en.wikipedia.org/wiki/X_Window_System#Remote_desktop). The solutions to the challenges we found to run Qt in that environment are collected in the [x11.environ] file.
+We tested Cook-a-Dream on an Ubuntu 20.04.3 server with acceleration with NVIDIA TITAN Xp GPUs. In our tests, we ran Cook-a-Dream remotely, using [X11 forwarding](https://en.wikipedia.org/wiki/X_Window_System#Remote_desktop). The solutions to the challenges we found to run Qt in that environment are collected in the [x11.environ](x11.environ) file.
 
 
 ### 1.2.2. macOS

update_version.sh

@@ -0,0 +1,43 @@
+# Update sister repository
+if [ "$1" != "" ] && [ "$1" != "-r" ] && [ "$1" != "--run" ]; then
+    echo "usage: update_public.sh [-r|--run]" >&2
+    echo "       without the parameter -r/--run, a dry-run will be executed instead" >&2
+    exit 1
+fi
+if [ "$1" == "-r" ] || [ "$1" == "--run" ]; then
+    dry=N
+else
+    dry=Y
+fi
+
+set -eu
+
+function stackd { pushd "$1" > /dev/null; }
+function destackd { popd &> /dev/null; }
+
+script_dir=$(dirname "$0")
+target_dir="../cookadream_public"
+
+stackd "$script_dir"
+function finish {
+    while destackd; do :; done
+}
+trap finish EXIT
+
+commit="$(git log -n 1 --pretty=format:'%H')"
+
+stackd "$target_dir"
+git fetch --tags
+version="$(git describe --tags --abbrev=0)"
+# commit="$(git rev-list -n 1 "$version")"
+destackd
+
+if [ "$dry" == "N" ]; then
+    output="utils/version_info.py"
+else
+    output="/dev/stdout"
+fi
+{
+    echo "PRODUCT_VERSION = '$version'"
+    echo "PRODUCT_COMMIT = '$commit'"
+} > "$output"

utils/version_info.py

@@ -1,2 +1,2 @@
-PRODUCT_VERSION = '0.1.0'
-PRODUCT_COMMIT = 'pre-release-0000000000000000000000000000'
+PRODUCT_VERSION = 'v0.1.0'
+PRODUCT_COMMIT = 'a8d9eb8227f982833d678cd38c1e9263f6c4e8f5'