From eb3cbb7aef4ba4f1495d1bb299a863492283b1f1 Mon Sep 17 00:00:00 2001
From: Robert Adams <misterblue@misterblue.com>
Date: Sun, 19 Jan 2025 20:01:44 +0000
Subject: [PATCH] Add README.md files for the images.

---
 image-opensim-herbal3d/README.md |  9 +++++++++
 image-opensim-webrtc/README.md   | 27 +++++++++++++++++++++++++++
 image-opensim/README.md          | 22 ++++++++++++++++++++++
 3 files changed, 58 insertions(+)
 create mode 100644 image-opensim-herbal3d/README.md
 create mode 100644 image-opensim-webrtc/README.md
 create mode 100644 image-opensim/README.md

diff --git a/image-opensim-herbal3d/README.md b/image-opensim-herbal3d/README.md
new file mode 100644
index 0000000..6bd2e56
--- /dev/null
+++ b/image-opensim-herbal3d/README.md
@@ -0,0 +1,9 @@
+# image-opensim-herbal3d
+
+This builds an image of the master branch of OpenSimulator
+with the [Herbal3d] addon-modules.
+
+This is meant for testing and will keep changing so it
+is be best that most everyone ignore this image.
+
+[Herbal3d]: https://herbal3d.github.io/
diff --git a/image-opensim-webrtc/README.md b/image-opensim-webrtc/README.md
new file mode 100644
index 0000000..756b0af
--- /dev/null
+++ b/image-opensim-webrtc/README.md
@@ -0,0 +1,27 @@
+# image-opensim-webrtc
+
+This builds an image of the master branch of the OpenSimulator repository
+that includes the addon-module [os-webrtc-janus].
+That is, this is OpenSimulator with WebRTC voice.
+
+There will be additional configuration for voice so refer to [os-webrtc-janus].
+
+There are two configurations supplied for this image:
+
+`config-standalone` runs OpenSimulator as a standalone instance
+that has both the region simulators and grid services in a local
+instance.
+This is great for testing or just getting confortable with what
+OpenSimulator can do.
+
+`config-osgrid` has the [OSGrid] connection configuration for
+hosting a region connected to that grid.
+You MUST change `Regions.ini` to a allocated location in
+that grid.
+Notice that all the .ini files supplied are the defaults
+from the OpenSimulator distribution and all the [OSGrid]
+configuration is done in `Final.ini`.
+
+[OSGrid]: https://osgrid.org
+[OpenSimulator]: http://opensimulator.org
+[os-webrtc-janus]: https://github.com/Misterblue/os-webrtc-janus
diff --git a/image-opensim/README.md b/image-opensim/README.md
new file mode 100644
index 0000000..ea5f1f2
--- /dev/null
+++ b/image-opensim/README.md
@@ -0,0 +1,22 @@
+# image-opensim
+
+This builds an image of the master branch of the OpenSimulator repository.
+
+There are two configurations supplied for this image:
+
+`config-standalone` runs OpenSimulator as a standalone instance
+that has both the region simulators and grid services in a local
+instance.
+This is great for testing or just getting confortable with what
+OpenSimulator can do.
+
+`config-osgrid` has the [OSGrid] connection configuration for
+hosting a region connected to that grid.
+You MUST change `Regions.ini` to a allocated location in
+that grid.
+Notice that all the .ini files supplied are the defaults
+from the OpenSimulator distribution and all the [OSGrid]
+configuration is done in `Final.ini`.
+
+[OSGrid]: https://osgrid.org
+[OpenSimulator]: http://opensimulator.org