youwen5/liminalOS
1
0
Fork 0
mirror of https://github.com/youwen5/nixos.git synced 2025-01-17 20:52:09 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: move diagram to top

Browse source
This commit is contained in:
Youwen Wu 2025-01-16 17:11:58 -08:00
parent 517a1a49c1
commit e8e2d347d2
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -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