feat(readme): add structure section and update README.md
This commit is contained in:
parent
e884735f25
commit
2dd8d0f73d
2 changed files with 18 additions and 12 deletions
|
@ -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.
|
||||
The list of generated files are:
|
||||
- [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).
|
||||
|
|
|
@ -1,21 +1,25 @@
|
|||
{ config, lib, ... }:
|
||||
let
|
||||
inherit (lib) singleton;
|
||||
in
|
||||
{ config, ... }:
|
||||
{
|
||||
text.readme = {
|
||||
heading = "Pantheon";
|
||||
description = ''
|
||||
This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts.
|
||||
'';
|
||||
description = # markdown
|
||||
''
|
||||
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 =
|
||||
{ pkgs, ... }:
|
||||
{
|
||||
files.files = singleton {
|
||||
path_ = "README.md";
|
||||
drv = pkgs.writeText "README.md" config.text.readme;
|
||||
};
|
||||
files.files = [
|
||||
{
|
||||
path_ = "README.md";
|
||||
drv = pkgs.writeText "README.md" config.text.readme;
|
||||
}
|
||||
];
|
||||
};
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue