dan/liminix
1
0
Fork 5
Code

convert "supported hardware" to an appendix

Browse Source
This commit is contained in:
Daniel Barlow 2025-04-08 21:24:31 +01:00
parent 6a7aa0898e
commit eb16a35ff3
3 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Makefile
View File

@ -12,8 +12,8 @@ DOCS=\
hardware.adoc: hardware.nix
pandoc -f rst -t asciidoc -o $@ hardware.rst
# don't even ask
sed -E -i.bak -e 's/^=(=*) /\1 /g' hardware.adoc
# sections in an appendix need to start at ===
sed -E -i.bak -e 's/^(=*) /=\1 /g' hardware.adoc
html: Makefile $(patsubst %,%.adoc,$(DOCS))
asciidoctor -D _build -d book index.adoc

14
doc/hardware.nix
View File

@ -11,7 +11,7 @@ let
d' = {
description = ''
${n}
${substring 0 (stringLength n) "********************************"}
${substring 0 (stringLength n) "============================"}
'';
} // d;
in
@ -19,18 +19,6 @@ let
) devices;
in
writeText "hwdoc" ''
Supported hardware
##################
For development, the `GL.iNet GL-MT300A <https://www.gl-inet.com/products/gl-mt300a/>`_
is an attractive choice as it has a builtin "debrick" procedure in the
boot monitor and is also comparatively simple to
attach serial cables to (soldering not required), so it
is lower-risk than some devices.
For a more powerful device, something with an ath10k would be the safe bet,
or the Linksys E8450 which seems popular in the openwrt community.
${lib.concatStringsSep "\n\n" texts}
''

15
doc/index.adoc
View File

@ -1,5 +1,6 @@
= Liminix
Daniel Barlow
:doctype: book
:toc: left
include::intro.adoc[]
@ -20,4 +21,18 @@ include::modules.adoc[]
include::code-of-conduct.adoc[]
[appendix]
= Supported hardware
=== Recommended devices
For development, the supported GL.iNet devices are all good choices if
you can find them, as they have a builtin "debrick" procedure in the
boot monitor and are also comparatively simple to attach serial cables
to (soldering not required), so are lower-risk than some other devices.
For a more powerful device, something with an ath10k wireless would be
the safe bet, or the Linksys E8450 which seems popular in the OpenWrt
community.
include::hardware.adoc[]