From 4f1db2acf53f46b4dbc2069f3adb5b60dc2eeb4f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Karel=20Ko=C4=8D=C3=AD?= <cynerd@email.cz>
Date: Tue, 1 Nov 2022 16:44:55 +0100
Subject: docs: add some initial more advanced documentation

The primary point of this is to describe installation procedure but we
should also describe basic router usage with NixOS as that ain't
documented elsewhere.
---
 docs/README.adoc | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docs/README.adoc

(limited to 'docs/README.adoc')

diff --git a/docs/README.adoc b/docs/README.adoc
new file mode 100644
index 0000000..6a264a4
--- /dev/null
+++ b/docs/README.adoc
@@ -0,0 +1,27 @@
+= NixOS for Turris routers documentation
+
+Please see general remarks about this project in the top level
+../README.adoc[README file].
+
+To start with NixOS on Turris please read install documentation for your
+specific board:
+
+* ./install-omnia.adoc[*Omnia installation*]
+* ./install-mox.adoc[*Mox installation*]
+
+The board specific instructions provide you with hopefully working installation
+of the NixOS on Turris OS. The following articles should give you more info on
+how to manage it:
+
+* ./initial-access.adoc[*Initial router access*]
+* ./nixos-rebuild-remote.adoc[*NixOS rebuild remotely and pushing changes*]
+* ./nixos-rebuild-onsite.adoc[*NixOS rebuild on the router*]
+* ./switch.adoc[*Switch setup*]
+* ./router.adoc[*Router setup*]
+* ./wifi-ap.adoc[*Wi-Fi Access Point*]
+
+Some additional topics:
+
+* ./qemu-build.adoc[*Cross build vs Qemu build*]
+* ./build-tarball.adoc[*Building system tarball*]
+* ./todo.adoc[*Things to be done and improved*]
-- 
cgit v1.2.3

