diff --git a/.github/README.md b/.github/README.md index 22d000921..beb2a54a3 100644 --- a/.github/README.md +++ b/.github/README.md @@ -2,26 +2,37 @@ dots

isabel's dotfiles

- stars - - repo size + stars + ci + repo size + license + nixos-unstable
-![preview.png](./preview.png) +![Preview image](./preview.png) +- [Foreword](#foreword) - [What does this repo provided](#what-does-this-repo-provided) - - [Shortcuts](#shortcuts) - [Config layout](#config-layout) -- [Install Notes](#install-notes) - - [NixOS](#nixos) - - [macOS](#macos) +- [Usage Notes](#usage-notes) + - [Using the templates](#using-the-templates) + - [Shortcuts](#shortcuts) + - [Installation Notes](#installation-notes) + - [NixOS](#nixos) + - [macOS](#macos) - [Awesome people, they really helped me learn](#awesome-people-they-really-helped-me-learn) +### Foreword + +This repository contains my **personal** configuration for my systems. Its really important that you know it's **personal** and not everything will fit your needs or even work out of the box for you without some changes. + +It's also significant to not that this configuration will **not** work if you do not change any of the [secrets](../secrets) since they are encrypted. + ### What does this repo provided - Several applications and tools for the same purpose, so you can choose the one that best suits your needs @@ -31,7 +42,48 @@ - `bash`, `zsh`, `fish` and `nushell` for shells - Modular configuration, so you can add or remove parts of the configuration - Sensible defaults, so you can get started quickly -- [Catppuccin](https://github.com/catppuccin/catppucin) everywhere +- Docs kind of +- [Catppuccin](https://github.com/catppuccin/catppucin) everywhere, with a hint of [evergarden](https://github.com/comfysage/evergarden) + +### Config layout + +- 🏠 [home](../home/) Where all home-manager configurations lie +- 🖥️ [hosts](../hosts/) + - ☀️ [Amaterasu](../hosts/amatarasu/) My high-end gaming machine + - 🐉 [Hydra](../hosts/hydra/) A super mid spec laptop + - ⚸ [Lilith](../hosts/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh + - 🪄 [Luz](../hosts/luz/) A server configuration for some of my infrastructure + - 𖤍 [Valkyrie](../hosts/valkyrie/) A WSL2 host, designed to be a development environment on Windows + - 💮 [Tatsumaki](../hosts/tatsumaki/) A MacBook Air, configured to last a whole day of university +- 🧩 [parts](../parts/) NixOS parts breaking down the complex configuration into smaller more manageable chunks + - 📚 [lib](../parts/lib/) Useful repeated functions + - 🛠️ [templates](../parts/templates/) Templates for setting up development environments + - 👾 [modules](../parts/modules/) Exported modules for NixOS, home-manager and Nix Darwin + - 🗗 [overlays](../parts/overlays/) Package overlays +- 📝 [docs](../docs/) Documentation for the configuration which can be found [here](https://isabelroses.github.io/dotfiles/) +- 🔌 [modules](../modules/) + - [base](../modules/base/) The base configuration settings, which are common between all systems + - [darwin](../modules/darwin/) pre made modules for exclusively darwin systems + - [nixos](../modules/nixos/) pre cooked modules for exclusively nixos systems + - [iso](../modules/iso/) pre configured modules prepared for making NixOS iso images + - [extra](../modules/extra) extra configuration modules, for home-manager and Nix Darwin and NixOS + - [profiles](../modules/profiles/) pre made profiles for different system types + - [hardware](../modules/profiles/hardware) optimized settings for different devices (e.g. laptop, servers, desktop) + - [meta](../modules/profiles/meta) optimized configurations for different natures (e.g. headless, graphical) + +> [!TIP] +> If you were looking for my custom modules or packages you should direct yourself to [isabelroses/beapkgs](https://github.com/isabelroses/beapkgs). + +### Usage Notes + +#### Using the templates + +To use the templates there are two commands you can run, they are: + +- `nix flake init -t github:isabelroses/dotfiles#