swarsel/.dotfiles
1
0
Fork 0
mirror of https://github.com/Swarsel/.dotfiles.git synced 2025-12-06 00:57:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation improvements

Browse source 
docs: Add Wiki section for (legacy) configuration snippets in case
they are deleted from the main configuration
docs: Add more details on matrix handling
This commit is contained in:
Swarsel 2024-06-13 02:31:04 +02:00
parent d5a18a84d5
commit 1ddc3eb81d
Signed by: swarsel
GPG key ID: 26A54C31F2A4FD84
4 changed files with 212 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/README.md vendored
View file

@ -44,6 +44,7 @@ Sadly all things nix feel a bit underdocumented (even though it mostly is not).
- Also useful is the [NixOS wiki](https://nixos.wiki/wiki/Main_Page), but some pages are outdated, so use with some care
- When you are trying to setup a new configuration part, GitHub code search can really help you to find a working configuration.
- getting packages not maintained in a standard repository can be done in most cases easily with fetchFromGithub (https://ryantm.github.io/nixpkgs/builders/fetchers/)
- I have gathered some configuration snippets here: [Wiki.org](../Wiki.org). I will update this whenever I come across an interesting bit.
### Deployment
Below is a rough general guide to setup this system on a new NixOS host. **Again**, this is not recommended as this is a personal configuration. This also might not be the most efficient way to deploy a new Nix system, but it should work in the general case.
@ -51,7 +52,7 @@ Below is a rough general guide to setup this system on a new NixOS host. **Again
For a pure Home-Manager configuration, you need a few different steps. The biggest change is that you then want to call `home-manager --flake .#<your-username>@<your-hostname> switch` as the last step instead of `nixos-rebuild [...]`. A complete general guide for that case cannot really be given since you are most likely setting up the flake on a existing machine that already has a lot of configuration. If you are setting up a new system, I would recommend to use NixOS unless circumstances force you to use something else.
###### To do that:
1) adapt [Nix.org](../.dotfiles/Nix.org)
1) adapt [Nix.org](../Nix.org)
1) adapt system specific options:
- Make a copy of "System Specific Configurations/TEMPLATE".
- Adapt all references to TEMPLATE to your host- and usernames etc - pay special attention to the header lines in each nix source block, i.e. the "#+begin_src nix [...] :tangle profiles/TEMPLATE/[...]" lines.