update readme

This commit is contained in:
Anthony Rodriguez 2024-10-11 17:54:32 +02:00
parent 6acfe1b0ef
commit 59b57de785
Signed by: nezia
GPG key ID: EE3BE97C040A86CE

View file

@ -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. - Wayland compositor: [niri](https://github.com/YaLTeR/niri)
- `hosts/`: Directory containing the specific configurations for each host (`vamos` and `solaire`). - Text editor: [neovim](https://github.com/neovim/neovim)
- `modules/`: Reusable NixOS modules shared between different configurations. - Shell: [fish](https://github.com/fish-shell/fish-shell)
- `home/`: Userspace configuration, divided between laptop and desktop. - 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 Some bits have also been borrowed from within the configuration, and credit has been given when its due.
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 .#<hostname>
```
Replace `<hostname>` 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.