docs(readme): add acknowledgements and git links
This commit is contained in:
parent
95fea9184e
commit
fc477267ed
2 changed files with 25 additions and 5 deletions
15
README.md
15
README.md
|
@ -1,11 +1,7 @@
|
||||||
# Pantheon
|
# Pantheon
|
||||||
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.
|
||||||
|
It's hosted at https://git.rrv.sh/rrvsh/pantheon, and mirrored to https://github.com/rrvsh/pantheon.
|
||||||
|
|
||||||
## Generated Files
|
|
||||||
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)
|
|
||||||
## Structure
|
## Structure
|
||||||
The system configurations are defined in [`flake.manifest`](nix/manifest.nix).
|
The system configurations are defined in [`flake.manifest`](nix/manifest.nix).
|
||||||
`flake.manifest.owner` provides the attributes for the administrator user, including username and pubkey.
|
`flake.manifest.owner` provides the attributes for the administrator user, including username and pubkey.
|
||||||
|
@ -22,3 +18,12 @@ The other attributes under `flake.modules.nixos` should be opt-in, i.e. provide
|
||||||
`flake.profiles.nixos` provides profiles which use the options defined in `flake.modules.nixos` to define different roles for each system, such as graphical, laptop, headless, etc.
|
`flake.profiles.nixos` provides profiles which use the options defined in `flake.modules.nixos` to define different roles for each system, such as graphical, laptop, headless, etc.
|
||||||
Options should not be defined here.
|
Options should not be defined here.
|
||||||
`flake.contracts.nixos.*` will provide contracts, such as reverse proxies or databases, which will configure options on the provider and receiver host.
|
`flake.contracts.nixos.*` will provide contracts, such as reverse proxies or databases, which will configure options on the provider and receiver host.
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
Thanks to the following for inspiring this configuration. I highly recommend you look through their writings and configurations.
|
||||||
|
- [ornicar](https://github.com/ornicar/dotfiles) which is where I first heard of NixOS
|
||||||
|
- [No Boilerplate](https://www.youtube.com/watch?v=CwfKlX3rA6E&pp=0gcJCfwAo7VqN5tD) for making me finally try the OS
|
||||||
|
- [ryan4yin](https://nixos-and-flakes.thiscute.world/) for being an amazing introduction to NixOS, home-manager, and flakes
|
||||||
|
- [NotAShelf](https://github.com/NotAShelf/) for their blog and for the wonderful [NVF](https://github.com/notashelf/nvf)
|
||||||
|
- [mightyiam](https://github.com/mightyiam/infra) for their infrastructure repo using flake-parts
|
||||||
|
- [drupol](https://not-a-number.io/2025/refactoring-my-infrastructure-as-code-configurations/) for this blog post which convinced me to rebase my infra to use flake-parts
|
||||||
|
|
|
@ -5,6 +5,21 @@
|
||||||
description = # markdown
|
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.
|
||||||
|
It's hosted at https://git.rrv.sh/rrvsh/pantheon, and mirrored to https://github.com/rrvsh/pantheon.
|
||||||
|
'';
|
||||||
|
order = [
|
||||||
|
"Structure"
|
||||||
|
"Acknowledgements"
|
||||||
|
];
|
||||||
|
parts."Acknowledgements" = # markdown
|
||||||
|
''
|
||||||
|
Thanks to the following for inspiring this configuration. I highly recommend you look through their writings and configurations.
|
||||||
|
- [ornicar](https://github.com/ornicar/dotfiles) which is where I first heard of NixOS
|
||||||
|
- [No Boilerplate](https://www.youtube.com/watch?v=CwfKlX3rA6E&pp=0gcJCfwAo7VqN5tD) for making me finally try the OS
|
||||||
|
- [ryan4yin](https://nixos-and-flakes.thiscute.world/) for being an amazing introduction to NixOS, home-manager, and flakes
|
||||||
|
- [NotAShelf](https://github.com/NotAShelf/) for their blog and for the wonderful [NVF](https://github.com/notashelf/nvf)
|
||||||
|
- [mightyiam](https://github.com/mightyiam/infra) for their infrastructure repo using flake-parts
|
||||||
|
- [drupol](https://not-a-number.io/2025/refactoring-my-infrastructure-as-code-configurations/) for this blog post which convinced me to rebase my infra to use flake-parts
|
||||||
'';
|
'';
|
||||||
parts."Structure" = # markdown
|
parts."Structure" = # markdown
|
||||||
''
|
''
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue