1
0
mirror of https://github.com/Andrey0189/nixos-config-reborn.git synced 2025-09-15 10:06:00 +03:00

add README

This commit is contained in:
andrey_varnavskiy
2024-12-14 06:31:32 +05:00
parent 44aa0ff25c
commit e20eb30979

82
README.md Normal file
View File

@@ -0,0 +1,82 @@
# ❄️ NixOS Config Reborn
Welcome to my redesigned NixOS configuration built for efficiency and aesthetics. Right now I'm trying to commit something everyday. Let's see how long I can go.
![screenshot](./screenshots/screenshot1.png)
## ✨ Features
- **Multiple Hosts Support**: Easy to configure for different hosts.
- **Gruvbox Theme**: A perfect blend of vibrant and subtle colors.
- **Hyprland + Waybar**: 10/10 window compositor on Wayland.
- **Home Manager Integration**: lots of stuff configured.
- **Tmux**: with my own hotkeys.
- **Zsh + starship**: Efficient shell setup with lots of aliases.
## 🚀 Installation
To get started with this setup, follow these steps:
1. **Install NixOS**: If you haven't already installed NixOS, follow the [NixOS Installation Guide](https://nixos.org/manual/nixos/stable/#sec-installation) for detailed instructions.
2. **Clone the Repository**:
```bash
git clone https://github.com/Andrey0189/nixos-config-reborn
cd nixos-config-reborn
```
3. **Copy one of the hosts configuration to set up your own**:
```bash
cd hosts
cp -r slim3 <your_hostname>
cd <your_hostname>
```
4. **Put your `hardware-configuration.nix` file there**:
```bash
cp /etc/nixos/hardware-configuration.nix ./
```
5. **Edit `hosts/<your_hostname>/local-packages.nix` and `nixos/packages.nix` files if needed**:
```bash
vim local-packages.nix
vim ../../nixos/packages.nix
```
6. **Finally, edit the `flake.nix` file**:
```diff
...
outputs = { self, nixpkgs, home-manager, ... }@inputs: let
system = "x86_64-linux";
-- homeStateVersion = "24.11";
++ homeStateVersion = "<your_home_manager_state_version>";
-- user = "amper";
++ user = "<your_username>";
hosts = [
-- { hostname = "slim3"; stateVersion = "24.05"; }
-- { hostname = "330-15ARR"; stateVersion = "24.11"; }
++ { hostname = "<your_hostname>"; stateVersion = "<your_state_version>"; }
];
...
```
7. **Rebuilding**:
```bash
cd nixos-config-reborn
nixos-rebuild switch --flake ./#<hostname>
# or nixos-install --flake ./#<hostname> if you are installing on a fresh system
home-manager switch
```
## 😎 Enjoy!
![screenshot](./screenshots/screenshot2.png)
## 🤝 Contributions
Feel free to fork the repository and submit pull requests if you'd like to contribute improvements. Open issues if you encounter any problems with the config or have ideas for new features.