Docker, bug fixes, and more

README

@@ -1,46 +1,36 @@
 +-----------------------------------------------------------------------------+
- README - README - README - README - README - README - README - README - README
-   Introductory information for the Unix talker code Amnuts
+     README - README - README - README - README - README - README - README
+              Introductory information for the Amnuts talker code
 +-----------------------------------------------------------------------------+
 
-Welcome to the Amnuts talker code, version 2.3.0!  Or, if you have already
-used Amnuts, then welcome back!  This is the latest version of Amnuts and MANY
-things have changed.
+Welcome to the Amnuts talker code!  Or, if you have already used Amnuts, then
+welcome back - it's good to still have you with us. :-)
 
-Amnuts development slowed down for a (long) while, but thanks to two people
-in particular, it managed to get back on track.  These people go by the handles
-'Ardant' and 'Uzume'.  Ardant supplied a CVS repository and bug tracking
-software for Amnuts, and Uzume and worked tirelessly in updating Amnuts and
-making it more stable.  Many thanks to both of them.
+It has been 20 years - yup, two whole decades - since this README was last
+updated, and, honestly, not much has changed in the world of Amnuts Talkers.
+The Golden Age of talkers has long past, though it's still awesome to see some
+die-hard fans still out there and keeping talkers alive (Marado's TalkerNode,
+for example).
 
-Because of the CVS and Bugzilla, a new website was set up for the development
-of the Amnuts talker code.  This can be found at:
+As for Amnuts, as you're undoubtedly aware, it's now available from GitHub:
 
-   http://www.amnuts.net/
+    https://github.com/amnuts/Amnuts
+ or https://amnuts.net/
 
-Instructions can be found there on how to use CVS and Bugzilla.  If you find
-any bugs with this version of Amnuts then it would be appreciated if you use
-Bugzilla to report them.  From the CVS repository you can download the latest
-files.
+You can submit issues and post up on the discussion board there.  Please feel
+free to fork and submit pull requests.
 
-The Amnuts code can be found, as always, at:
+To get started with Amnuts you'll need either a linux environment or you can
+use docker.  For further details, see the docs/docker and and other related
+files in the docs directory.
 
-   http://amnuts.talker.com/
+Lots of the documentation and files where haven't been updated for those same
+two decades, but hopefully one day they will be revived and revamped.  Until
+then, just head towards the wind and push on as best you can. ;-)
 
-or can now also be access via:
+Thanks for using Amnuts and, as you're here you must be interested in talkers,
+so thanks also for keeping those alive!  Enjoy!
 
-   http://www.amnuts.org/
-
-Please read the 'IMPORTANT' file, and the 'amnuts_changes' in the DOCs
-directory for more information on what changes have been made since
-version 2.2.1 (the previous release to this one) because there have been a
-LOT of them!  Even if you are a previous Amnuts user, programmer, owner,
-whatever - you should STILL READ THE FILES! :)
-
-Thanks for using Amnuts!  Enjoy!
-
-
-                                                              Andrew Collington
-                                                    The Amnuts Development Team
-                                                                   August, 2003
+                                                             Andrew Collington
+                                                                February, 2023
 +-----------------------------------------------------------------------------+

docs/docker

@@ -0,0 +1,41 @@
++------------------------------------------------------------------------------+
+ DOCKER - DOCKER - DOCKER - DOCKER - DOCKER - DOCKER - DOCKER - DOCKER - DOCKER
+                 Information on spinning up Amnuts with Docker
++------------------------------------------------------------------------------+
+
+The Docker setup for Amnuts is pretty new and probably doesn't cover all the
+needs you could want, and if you have to change things then you're pretty much
+on your own.  However, it could provide you a way to compile and run an Amnuts
+based talker without having all the GCC requirements installed... So long as
+you have bash and docker, you should be able to get up and running pretty easily.
+
+To start with, you'll need to run:
+
+    ./docker-startup.sh
+
+This will create the Dockerfile and docker-compose.yml files for your platform
+(amd64 or arm64v8 are supported).  If you make changes to the docker-startup.sh
+file or the accompanying supervisord.conf file, you'll need to remove the
+previously built image (assuming you have built one) and run the docker-setup
+file again.
+
+To compile the code, use the command:
+
+    docker-compose run --rm amnuts make install
+
+This will build the image if you haven't already, create a container, compile
+the talker, then remove the container.  Because all the files are mounted as a
+volume, you'll not lose any files when the container is removed.
+
+In fact, you can run any of the Makefile commands this way, eg:
+
+    docker-compose run --rm amnuts make distclean
+
+If you want to jump on the container itself, use:
+
+    docker-compose run --rm amnuts /bin/bash
+
+Once you have run the "make install" command, you can then start the talker
+with:
+
+    docker-compose run amnuts