diff --git a/README.md b/README.md index 0703dfb..4cb2791 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,32 @@ -# My NixOS Flake +# ❄️ nix -This repository contains my personal NixOS configurations for two machines: my laptop (`vamos`) and my desktop computer (`solaire`). These configurations are managed using the Nix Flake system to ensure reproducibility and ease of deployment. +My NixOS configurations, using flakes. -## Structure +# Software I use -- `flake.nix`: The main entry point for the Nix flake. -- `hosts/`: Directory containing the specific configurations for each host (`vamos` and `solaire`). -- `modules/`: Reusable NixOS modules shared between different configurations. -- `home/`: Userspace configuration, divided between laptop and desktop. +- Wayland compositor: [niri](https://github.com/YaLTeR/niri) +- Text editor: [neovim](https://github.com/neovim/neovim) +- Shell: [fish](https://github.com/fish-shell/fish-shell) +- Colors: [Catppuccin](https://github.com/catppuccin/catppuccin) +- Font: [Intel One Mono](github.com/intel/intel-one-mono) -## Hosts +Additionally using a lot of other software you can find in the configuration files. -### Vamos (Laptop) +# 🛠️ Structure -This is the configuration for my laptop, `vamos`. It uses Gnome, and includes settings optimized for power management, and lightweight applications. +| Name | Description | +| ------------------- | ------------------------------------------------- | +| [home](home/) | Home manager configuration | +| [hosts](hosts/) | Host-specific (entry-points of the configuration) | +| [lib](lib/) | Helper functions | +| [modules](modules/) | NixOS modules | +| [system](system/) | Common NixOS configuration | -### Solaire (Desktop) +# 👥 Credits -This is the configuration for my desktop computer, `solaire`. It also uses Gnome, and adds Nvidia drivers. +People / repositories I have copied / learned from: -## Usage +- [fufexan/dotfiles](https://github.com/fufexan/dotfiles) for the configuration structure +- [jacekpoz/nixos](https://git.jacekpoz.pl/poz/niksos) for learning how NixOS modules work -### Applying the Configuration - -To apply the configuration on a machine, use the following steps: - -1. Clone this repository: - -```bash -git clone https://github.com/nezia1/dotfiles.git .dotfiles -cd .dotfiles -``` - -2. Switch to the desired configuration: - - ```bash - sudo nixos-rebuild switch --flake .# - ``` - - Replace `` with either `vamos` or `solaire` depending on the machine you are configuring. - -### Example - -For the laptop (`vamos`): - -```bash -sudo nixos-rebuild switch --flake .#vamos -``` - -For the desktop (`solaire`): - -```bash -sudo nixos-rebuild switch --flake .#solaire -``` - -## License - -This repository is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. +Some bits have also been borrowed from within the configuration, and credit has been given when its due.