aiolabs/omnixient
9
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

docs: point template + install docs at the real Omnixient repo

Browse source 
Replace the <your-org> placeholders with the actual public URL
(git+https://git.atitlan.io/aiolabs/omnixient, https so forkers need no
SSH), and switch the packs standalone-import example from git+ssh to the
same https URL.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Padreug 2026-06-28 11:45:27 +02:00
commit a31369fea8
4 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/getting-started.md
View file

@ -33,7 +33,7 @@ You update it like any dependency; it never touches your files.
## 1. Scaffold your config ## 1. Scaffold your config
```bash ```bash
nix flake init -t github:<your-org>/omnixient # writes flake.nix + hosts/myhost/ nix flake init -t git+https://git.atitlan.io/aiolabs/omnixient # writes flake.nix + hosts/myhost/
cd <your-config> cd <your-config>
``` ```
@ -41,7 +41,7 @@ This drops a starter that already wires `omni.lib.mkSystem` +
`omni.nixosModules.omni`. Open `flake.nix` and: `omni.nixosModules.omni`. Open `flake.nix` and:
- set `omni.url` to the real repo (pin a tag for reproducibility, e.g. - set `omni.url` to the real repo (pin a tag for reproducibility, e.g.
`github:<your-org>/omnixient/v1.0.0`); `git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0`);
- fill in the `settings` block: - fill in the `settings` block:
```nix ```nix
@ -167,7 +167,7 @@ sudo nixos-rebuild switch --flake .#myhost
This **can't** conflict with your config — Omnixient is a pinned dependency, This **can't** conflict with your config — Omnixient is a pinned dependency,
not a checkout. Roll back by reverting `flake.lock`; pin a release with not a checkout. Roll back by reverting `flake.lock`; pin a release with
`omni.url = "github:<your-org>/omnixient/v1.0.0"`. `omni.url = "git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0"`.
--- ---
@ -206,7 +206,7 @@ it never gets in your way until you ask for it.
## Building a custom ISO (optional) ## Building a custom ISO (optional)
From an Omnixient checkout (or `nix build github:<your-org>/omnixient#omni-iso`): From an Omnixient checkout (or `nix build git+https://git.atitlan.io/aiolabs/omnixient#omni-iso`):
```bash ```bash
nix build .#omni-iso # → result/iso/nixos-*.iso nix build .#omni-iso # → result/iso/nixos-*.iso
@ -222,7 +222,7 @@ If you want to modify Omnixient's own modules/themes rather than just consume
them, fork the repo and edit in place: them, fork the repo and edit in place:
```bash ```bash
git clone https://github.com/<your-org>/omnixient.git ~/omni && cd ~/omni git clone https://git.atitlan.io/aiolabs/omnixient.git ~/omni && cd ~/omni
``` ```
Then model a host on **`hosts/example/`** (copy it to `hosts/<yourhost>/`, Then model a host on **`hosts/example/`** (copy it to `hosts/<yourhost>/`,

2
docs/packs.md
View file

@ -93,7 +93,7 @@ flake as an input and import just the pack you want:
```nix ```nix
# your own flake.nix # your own flake.nix
inputs.omni.url = "git+ssh://forgejo@git.atitlan.io/aiolabs/omnixient"; inputs.omni.url = "git+https://git.atitlan.io/aiolabs/omnixient";
# your host's modules # your host's modules
{ {

4
templates/default/README.md
View file

@ -1,6 +1,6 @@
# My Omnixient config # My Omnixient config
Generated from Omnixient's starter template (`nix flake init -t github:<your-org>/omnixient`). Generated from Omnixient's starter template (`nix flake init -t git+https://git.atitlan.io/aiolabs/omnixient`).
You consume Omnixient as a flake **input** — you do not fork it — so You consume Omnixient as a flake **input** — you do not fork it — so
`nix flake update omni` pulls upstream changes without ever touching `nix flake update omni` pulls upstream changes without ever touching
your files. your files.
@ -32,7 +32,7 @@ sudo nixos-rebuild switch --flake .#myhost
This can't conflict with your config — Omnixient is an input, not a checkout. This can't conflict with your config — Omnixient is an input, not a checkout.
Roll back by reverting `flake.lock`. Pin a release with Roll back by reverting `flake.lock`. Pin a release with
`omni.url = "github:<your-org>/omnixient/v1.0.0"`. `omni.url = "git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0"`.
## Secrets (optional) ## Secrets (optional)

2
templates/default/flake.nix
View file

@ -5,7 +5,7 @@
# Pin Omnixient. Point this at the canonical repo or your own fork, and # Pin Omnixient. Point this at the canonical repo or your own fork, and
# ideally pin a release tag (…/omni/v1.0.0) for reproducible updates: # ideally pin a release tag (…/omni/v1.0.0) for reproducible updates:
# nix flake update omni # pull the latest Omnixient, never touches your config # nix flake update omni # pull the latest Omnixient, never touches your config
omni.url = "github:<your-org>/omnixient"; omni.url = "git+https://git.atitlan.io/aiolabs/omnixient";
# Reuse Omnixient's nixpkgs so you evaluate a single package set. # Reuse Omnixient's nixpkgs so you evaluate a single package set.
nixpkgs.follows = "omni/nixpkgs"; nixpkgs.follows = "omni/nixpkgs";
}; };