DGNum/liminix
14
0
Fork 2
Code Issues 15 Pull requests 7 Projects Releases Packages Wiki Activity Actions

docs: add hardware recommendation

Browse source 
Also add infrastructure to also generate the supported hardware
page when building the docs locally
This commit is contained in:
Arnout Engelen 2024-01-04 14:34:46 +01:00
parent 9632a64b47
commit d5026c2074
No known key found for this signature in database
GPG key ID: 061107B0F74A6DAA
5 changed files with 18 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -6,3 +6,4 @@ result-*
_build _build
*-secrets.nix *-secrets.nix
examples/static-leases.nix examples/static-leases.nix
/doc/hardware.rst

2
README.md
View file

@ -33,7 +33,7 @@ functioning version, see [the CI system](https://build.liminix.org/jobset/limini
Documentation is in the [doc](doc/) directory. You can build it Documentation is in the [doc](doc/) directory. You can build it
by running by running
nix-shell -p sphinx --run "make -C doc html" nix-shell -p sphinx --run "make -C doc hardware.rst html"
Rendered documentation corresponding to the latest commit on `main` Rendered documentation corresponding to the latest commit on `main`
is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/) is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/)

6
doc/Makefile
View file

@ -12,9 +12,13 @@ BUILDDIR = _build
help: help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
hardware.rst: hardware.nix
@rm -f hardware.rst || true
@cp $$(nix-build hardware.nix) hardware.rst
.PHONY: help Makefile .PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile html: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

9
doc/hardware.nix
View file

@ -24,6 +24,15 @@ writeText "hwdoc" ''
Supported hardware 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} ${lib.concatStringsSep "\n\n" texts}
'' ''

2
doc/tutorial.rst
View file

@ -138,6 +138,8 @@ unbrick if necessary.
work here, but you accept the slightly greater bricking work here, but you accept the slightly greater bricking
risk if it doesn't. risk if it doesn't.
See :doc:`hardware` for device support status.
You may want to read and inwardly digest the Develoment Manual section You may want to read and inwardly digest the Develoment Manual section
:ref:`serial` when you start working with Liminix on real hardware. You :ref:`serial` when you start working with Liminix on real hardware. You
won't *need* serial access for this example, assuming it works, but it won't *need* serial access for this example, assuming it works, but it