Skip to content

Commit cf4a29d

Browse files
committed
Update link to (new) documentation and fix admonition
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent edc1346 commit cf4a29d

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ different platforms, simplify long-term maintenance, and provide
88
made-easy management using NETCONF, RESTCONF[^2], or the built-in
99
command line interface (CLI) from a console or SSH login.
1010

11-
> Click the **▶ Example CLI Session** foldout below for an example, or
12-
> head on over to the [Infix Documentation](doc/README.md) for more
13-
> information on how to set up the system.
11+
> [!TIP]
12+
> _Curious how it works?_ Click the **▶ Example CLI Session** below to see
13+
> it in action
14+
> — or jump into the comprehensive [Infix Documentation][4] to learn even more.
1415
15-
Although primarily focused on switches and routers, the core values
16-
may be appealing for other use-cases as well:
16+
Geared for switches and routers — yet its core value fits plenty of
17+
other use cases:
1718

1819
- Runs from a squashfs image on a read-only partition
1920
- Single configuration file on a separate partition
@@ -95,6 +96,7 @@ The [following boards](board/aarch64/README.md) are fully supported:
9596
- Marvell CN9130 CRB
9697
- Marvell EspressoBIN
9798
- Microchip SparX-5i PCB135 (eMMC)
99+
- NXP i.MX8MP EVK
98100
- Raspberry Pi 4B
99101
- NanoPi R2S
100102

@@ -123,16 +125,17 @@ Environments](doc/virtual.md).
123125
[^1]: An immutable operating system is one with read-only file systems,
124126
atomic updates, rollbacks, declarative configuration, and workload
125127
isolation. All to improve reliability, scalability, and security.
126-
For more information, see <https://ceur-ws.org/Vol-3386/paper9.pdf>
127-
and <https://www.zdnet.com/article/what-is-immutable-linux-heres-why-youd-run-an-immutable-linux-distro/>.
128-
128+
For more information, see this [survey paper][5] and [article][6].
129129
[^2]: Partial RESTCONF support, features like HTTP PATCH, OPTIONS, HEAD,
130130
and copying between datastores are still missing.
131131

132-
[1]: https://buildroot.org/
133-
[2]: https://www.sysrepo.org/
132+
[1]: https://buildroot.org/ "Buildroot Homepage"
133+
[2]: https://www.sysrepo.org/ "Sysrepo Homepage"
134134
[3]: doc/cli/introduction.md
135-
[Latest Build]: https://github.com/kernelkit/infix/releases/tag/latest
135+
[4]: https://kernelkit.org/infix/ "Infix User's Guide"
136+
[5]: https://ceur-ws.org/Vol-3386/paper9.pdf "Immutable Operating Systems: A Survey"
137+
[6]: https://www.zdnet.com/article/what-is-immutable-linux-heres-why-youd-run-an-immutable-linux-distro/ "Why you should run an immutable Linux distro"
138+
[Latest Build]: https://github.com/kernelkit/infix/releases/tag/latest "Latest build"
136139
[License]: https://en.wikipedia.org/wiki/GPL_license
137140
[License Badge]: https://img.shields.io/badge/License-GPL%20v2-blue.svg
138141
[GitHub]: https://github.com/kernelkit/infix/actions/workflows/build.yml/

0 commit comments

Comments
 (0)