liminalOS/README.md

10 KiB
Executable file

liminalOS

This is a repository that implements liminalOS, my personal Linux distribution based on NixOS. The most overengineered personal 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.

A flowchart of the system is provided below:

Documentation is available.

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.

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!

Here's a snapshot of the entire dependency graph of the system, a directed acyclic graph (DAG) representing the relationships between every single piece of software installed, represented as nodes, all branching out from xgcc.

liminalos system graph

Hosts

The modules in liminalOS are designed to be utilized by a wide variety of machine configurations, including via nix-darwin on macOS. To that end, modules are organized by operating system (darwin vs. linux), architecture (x86_64 vs. aarch-64), and form factor (desktop vs laptop). Anything that is agnostic of these distinctions is considered a "common module" and allows configuration to be shared between the various host types. This generally includes core programs like CLI tools, the window manager, etc.

The flake.nix currently contains my configuration for four hosts:

Hostname Description
"callisto" a Macbook Pro M1 (2021) running under Asahi Linux. Imports the laptop module sets as well as the core NixOS module sets.
"demeter" a custom desktop with an i7-13700KF and RTX 4080. Imports the desktop module, the core NixOS modules, and additionally the gaming module.
"phobos" Macbook Pro M1 (2021) running macOS with nix-darwin. Imports the core home-manager module as well as some darwin-specific modules for window managers and the like.
"adrastea" Razer Blade 14 (2021) with RTX 3070. Imports the laptop module, the core NixOS modules, and the gaming module.