rrvsh/pantheon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(readme): add structure section and update README.md

Browse source
This commit is contained in:
Mohammad Rafiq 2025-07-06 19:24:18 +08:00
parent e884735f25
commit 2dd8d0f73d
No known key found for this signature in database
2 changed files with 18 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -5,4 +5,6 @@ This flake serves as a monorepo for my systems (using IaC), dotfiles, and script
This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation. This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation.
The list of generated files are: The list of generated files are:
- [docs/cheatsheet.md](docs/cheatsheet.md) - [docs/cheatsheet.md](docs/cheatsheet.md)
- [README.md](README.md) - [README.md](README.md)
## Structure
The system configurations are defined in [`flake.hostSpec`](nix/hostSpec.nix).

26
nix/flake-parts/files/readme.nix
View file

@ -1,21 +1,25 @@
{ config, lib, ... }: { config, ... }:
let
inherit (lib) singleton;
in
{ {
text.readme = { text.readme = {
heading = "Pantheon"; heading = "Pantheon";
description = '' description = # markdown
This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts. ''
''; This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts.
'';
parts."Structure" = # markdown
''
The system configurations are defined in [`flake.hostSpec`](nix/hostSpec.nix).
'';
}; };
perSystem = perSystem =
{ pkgs, ... }: { pkgs, ... }:
{ {
files.files = singleton { files.files = [
path_ = "README.md"; {
drv = pkgs.writeText "README.md" config.text.readme; path_ = "README.md";
}; drv = pkgs.writeText "README.md" config.text.readme;
}
];
}; };
} }