foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-02-07 12:19:07 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: add README for configs and Fiesta NixVim config

Browse Source
This commit is contained in:
Gabriel Arazas 2024-01-26 22:30:59 +08:00
parent 32a9acf197
commit 68d636bb59
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
configs/README.adoc Normal file
View File

@ -0,0 +1,18 @@
= Configs
:toc:
This is the folder containing various configurations for various environments, typically the ones configured using the Nix module system such as NixOS, home-manager, and nixvim.
Each of these configurations are assumed to use custom modules defined at link:../modules/[../modules/] (where it has similar folder structure).
Furthermore, these configurations do have a certain "codename" in the commits for easier inspection of the history.
Here is the following list of them used in the repo history:
* `hosts` for NixOS systems (e.g., `hosts/ni`).
* `users` for home-manager configurations (e.g., `users/foo-dogsquared`).
* `nixvimConfigs` for NixVim configurations (e.g., `nixvimConfigs/fiesta`).
* `flake` for flake-parts (seeing it only has one of them, it is constantly referred to as `flake`).
These "codenames" are also used for their environment-specific module structuring (e.g., `hosts.ni.services.backup.enable` for NixOS, `nixvimConfigs.fiesta.setups.tree-sitter` for NixVim, `users.foo-dogsquared.setups.desktop.enable` for home-manager) with the exception of flake-parts where it is basically a free-for-all.
Lastly, these modules are referred collectively in the commits as `modules`.

10
configs/nixvim/fiesta/README.adoc Normal file
View File

@ -0,0 +1,10 @@
= Fiesta, the main NixVim configuration
:toc:
It's the main NixVim configuration used for a variety of purposes.
I don't use NixVim primarily so it is only used as a potential note-taking setup and a main development setup.
Who knows?
It might grow into one.
For now, it's modelled after my Neovim configuration from https://github.com/foo-dogsquared/dotfiles[my dotfiles] which endangers my own Neovim configuration to be deprecated in favor of this NixVim config. :)