feat: add more liminalOS instructions
Some checks are pending
Deploy Quartz site to GitHub Pages using Nix / build (push) Waiting to run
Deploy Quartz site to GitHub Pages using Nix / deploy (push) Blocked by required conditions

This commit is contained in:
Youwen Wu 2025-01-02 03:24:54 -08:00
parent de2419bcc9
commit ed627ddb82
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3

View file

@ -86,9 +86,25 @@ configuration.
}
```
The recommended way to start using liminalOS is to first install NixOS and then
install liminalOS over it. It is trivially possible in theory to generate
liminalOS installer ISOs but this has not yet been developed. Hackers welcome
to try!
You can generate a basic set of NixOS configuration files that deploy liminalOS
using:
```bash
nix flake init -t github:youwen5/liminalOS
```
Make sure you read the comments and edit the desired options before
`nixos-rebuild`! At the very least, you should set your hostname and username.
## Full liminalOS module options
These are all of the available options set by `liminalOS`, automatically
generated from liminalOS' modules. Keep in mind that many of these are enabled
automatically when `liminalOS.enable` is set to true, but they are still
available for fine-grained customization.