mirror of
https://github.com/anotherhadi/nixy.git
synced 2026-04-02 11:12:09 +02:00
32
README.md
32
README.md
@@ -1,9 +1,4 @@
|
||||
[//]: # (Title: Nixy)
|
||||
[//]: # (Description: Nixy is a Hyprland NixOS configuration with home-manager, secrets and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles.)
|
||||
[//]: # (Author: Hadi)
|
||||
[//]: # (Date: 09/04/24)
|
||||
[//]: # (Version: v2.3.0)
|
||||
|
||||
[//]: # (This is autogenerated)
|
||||
<div align="center">
|
||||
<img src="https://raw.githubusercontent.com/anotherhadi/nixy/main/docs/src/logo.png" width="100px" />
|
||||
</div>
|
||||
@@ -14,9 +9,6 @@
|
||||
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=v2.3.0&colorA=181825&colorB=89b4fa&logo=githubactions&logoColor=89b4fa"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=89b4fa&labelColor=181825&style=for-the-badge&logo=starship&logoColor=89b4fa">
|
||||
</a>
|
||||
@@ -35,12 +27,20 @@
|
||||
**Nixy** is a **Hyprland** NixOS configuration with **home-manager**, **secrets**, and **custom theming** all in one place.
|
||||
It's a simple way to manage your system configuration and dotfiles.
|
||||
|
||||
*Key points:*
|
||||
|
||||
- Hyprecosystem first (Hyprland, hyprlock, hyprpanel, hypridle, ...)
|
||||
- Stylix/base16 themes
|
||||
|
||||
## Table of Content
|
||||
|
||||
- [Nixy](#nixy)
|
||||
- [Table of Content](#table-of-content)
|
||||
- [Gallery](#gallery)
|
||||
- [Architecture](#architecture)
|
||||
- [🏠 `home`](#-home)
|
||||
- [`nixos`](#nixos)
|
||||
- [`themes`](#themes)
|
||||
- [💻 `hosts`](#-hosts)
|
||||
- [Installation](#installation)
|
||||
- [Documentation](#documentation)
|
||||
@@ -64,18 +64,15 @@ Those are the dotfiles and configuration files for user-level configuration
|
||||
- `system` is some "desktop environment" configuration
|
||||
- `wallpapers` are... wallpapers
|
||||
|
||||
### `nixos`
|
||||
|
||||
### `themes`
|
||||
|
||||
### 💻 `hosts`
|
||||
|
||||
Those are the host-specific configurations
|
||||
Each host contains a `configuration.nix` for system-level configuration, a `home.nix` for user-level configuration, and a `variables.nix` for config wide variables.
|
||||
|
||||
**Subfolders:**
|
||||
|
||||
- 🎨 `themes` are the themes available *(see [THEMES.md](docs/THEMES.md))*
|
||||
- 📦 `modules` are the nix modules that you can import
|
||||
- `laptop` is my configuration for my laptop with Nvidia that you can copy
|
||||
- `server` is for my homeserver (w/nextcloud, nginx, vaultwarden, ...)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
@@ -96,10 +93,9 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname
|
||||
## Documentation
|
||||
|
||||
- [THEMES.md](docs/THEMES.md): How themes work and how to create your own
|
||||
- [APPS.md](docs/APPS.md): Which apps are installed
|
||||
- [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available
|
||||
- [KEYBINDINGS.md](docs/KEYBINDINGS.md): Keybindings available in Hyprland
|
||||
- [WALLPAPERS.md](docs/WALLPAPERS.md): Preview of every wallpapers available
|
||||
- [WALLPAPERS.md](https://github.com/anotherhadi/nixy-wallpapers): A collection of wallpapers for Nixy.
|
||||
|
||||
- [TODO.md](docs/TODO.md): What's next (feel free to contribute)
|
||||
- [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute
|
||||
|
||||
Reference in New Issue
Block a user