From 31ca3ec4fef41a43ba64d188ec05161616e37051 Mon Sep 17 00:00:00 2001
From: Denis Knauf <deac@denkn.at>
Date: Tue, 26 May 2020 11:47:27 +0200
Subject: [PATCH] README - architecture, installation

---
 README.adoc | 23 +++++++++++++++++++++++
 README.md   |  3 ---
 2 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 README.adoc
 delete mode 100644 README.md

diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..2d54ed4
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,23 @@
+# hexopi
+
+Multiple Octoprint-instances on one machine.  Uses systemd-nspawn.
+
+Additionally it installs cron-apt for unattended upgrades.
+
+# Installation
+
+You need to install make:
+
+	sudo apt install gmake
+
+Anything else will be installed automatically:
+
+	sudo make install
+
+# Architecture
+
+For any devices `/dev/ttyUSB*` it creates a octoprint-container.
+The octoprint-container based on the system installed at `/var/lib/machines/octoprint`
+and has its own directory for changed files `/var/lib/machines/octoprint@ttyUSB*`,
+a copy of `/var/lib/machines/octoprint-template`.
+You can reach octoprint via `http://{IP|HOST}:2000` for `ttyUSB0`, `http://{IP|HOST}:2001` for `ttyUSB1`, so on...
diff --git a/README.md b/README.md
deleted file mode 100644
index a3a1e28..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# hexopi
-
-Multiple Octoprint-instances on one machine.  Uses systemd-nspawn.
\ No newline at end of file