From e8e2d347d236e90f540a7def8551eb879c1475ed Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Thu, 16 Jan 2025 17:11:58 -0800 Subject: [PATCH] docs: move diagram to top --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5627c13..dbb1f53 100755 --- a/README.md +++ b/README.md @@ -6,22 +6,7 @@ computing environment, ever. Imagine having to `vim` into source code and recompile an entire operating system to change a font. Yes, I use this on a daily basis. -This repository exposes a NixOS module that declares the entire liminalOS -operating system. It aims to be an easy way to both set up a brand new system -with my opinionated configurations, and also inject into an existing NixOS -configuration. - -My reference implementations of liminalOS on actual working systems are -available [here](./reference). - -liminalOS is currently in a heavily experimental state, but it is used in -production every day! - -You can try it with `nix flake init -t github:youwen5/liminalOS`, which will -create a sample configuration flake along with corresponding files. Keep in -mind you'll have to do a little bit of work in these files to get a working -system configuration. Some Nix knowledge is expected, but comments are there to -help! +A flowchart of the system is provided below: ```mermaid flowchart TB @@ -125,6 +110,25 @@ flowchart TB classDef build fill:#f0f0a8,stroke:#333; ``` +This repository exposes a NixOS module that declares the entire liminalOS +operating system. It aims to be an easy way to both set up a brand new system +with my opinionated configurations, and also inject into an existing NixOS +configuration. + +My reference implementations of liminalOS on actual working systems are +available [here](./reference). + +liminalOS is currently in a heavily experimental state, but it is used in +production every day! + +You can try it with `nix flake init -t github:youwen5/liminalOS`, which will +create a sample configuration flake along with corresponding files. Keep in +mind you'll have to do a little bit of work in these files to get a working +system configuration. Some Nix knowledge is expected, but comments are there to +help! + + + ## Hosts The modules in liminalOS are designed to be utilized by a wide variety of