liminix

commit 5729cfb4a7b71f3da8df7b7b92cfafb8d7738813
parent 7d5c7b9b44f52314c841e5e9934377c384ee82a1
Author: Daniel Barlow <dan@telent.net>
Date:   Thu,  9 Nov 2023 22:12:29 +0000

document installation methods (only vmroot yet)

Diffstat:
M
ci.nix
 | 
1
+
M
doc/index.rst
 | 
1
+
A
doc/installers.rst
 | 
8
++++++++
A
doc/parse-options-outputs.fnl
 | 
11
+++++++++++

4 files changed, 21 insertions(+), 0 deletions(-)
diff --git a/ci.nix b/ci.nix
@@ -47,6 +47,7 @@ let
           src = ./.;
           buildPhase = ''
             cat ${json} | fennel --correlate doc/parse-options.fnl > doc/modules-generated.rst
+            cat ${json} | fennel --correlate doc/parse-options-outputs.fnl system.outputs.vmroot  > doc/installers-generated.rst
             cp ${(import ./doc/hardware.nix)} doc/hardware.rst
             make -C doc html
           '';
diff --git a/doc/index.rst b/doc/index.rst
@@ -12,6 +12,7 @@ Liminix
    development
    modules
    hardware
+   installers
 
 
 Indices and tables
diff --git a/doc/installers.rst b/doc/installers.rst
@@ -0,0 +1,8 @@
+Installers
+##########
+
+There are a number of different routes to getting
+Liminix onto devices, and which one you should use
+(or are able to use) varies according to the device.
+
+.. include:: installers-generated.rst
diff --git a/doc/parse-options-outputs.fnl b/doc/parse-options-outputs.fnl
@@ -0,0 +1,11 @@
+(local yaml (require :lyaml))
+
+;; (local { : view } (require :fennel))
+
+(local outputs (collect [k v (ipairs arg)]
+                 (values v true)))
+
+(each [_ option (ipairs (yaml.load (io.read "*a")))]
+  (when (. outputs option.name)
+    (print (.. ".. _" option.name) "\n")
+    (print option.description)))