diff options
Diffstat (limited to 'docs/README.adoc')
| -rw-r--r-- | docs/README.adoc | 27 |
1 files changed, 27 insertions, 0 deletions
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*] |