Serenity/README.md
2026-09-24 19:46:00 +10:00

110 lines
4.3 KiB
Markdown
Executable file

<div align="center">
# SerenityOS
_Declarative NixOS configuration with Flakes & Home Manager_
[![NixOS](https://img.shields.io/badge/NixOS-Unstable-blue?style=for-the-badge&logo=NixOS&logoColor=white&label=NixOS&labelColor=303446&color=91D7E3)](https://nixos.org)
[![License](https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=313244&colorB=F5A97F&logo=unlicense&logoColor=F5A97F&)](https://codeberg.org/Serenity-F/SerenityOS/src/branch/main/LICENSE)
</div>
<br>
![screenshot](https://codeberg.org/serenity-F/SerenityOS/raw/branch/main/assets/repository/desktop-screenshot.png)
## ✨ Key Features
- 🎨 **Unified Theming** with Stylix
- 🪟 **Niri** with **ReGreet** session management
- 🏠 **Home Manager** for declarative user environments
- 📦 **Modular Architecture** for easy customization
- 💬 **Fully commented** for understanding by 3rd parties
## 💻 System Information
### Software Stack
| Component | Implementation |
| ------------------ | ------------------------------------ |
| **OS** | NixOS Unstable |
| **Display Server** | Wayland |
| **Session Manager**| Regreet |
| **Window Manager** | Niri |
| **Desktop** | Noctalia |
| **Terminal** | Kitty |
| **Shell** | Fish |
| **Editor** | Helix |
| **Browser** | Firefox |
| **File Manager** | Yazi |
| **Theme** | Stylix |
| **Filesystem** | Ext4 + ZFS |
## 🛠️ System Management
### Common Commands
| Command | Description |
| ------------------------------------------ | -------------------------------------------------- |
| `hx <path/to/file>` | Edit file |
| `nix flake update` | Update system |
| `git add --all && git commit -m "<message>"`| Save system changes or updates to git tree |
| `sudo nixos-rebuild test --flake .#<host>` | Test changes or updates without switching |
| `sudo nixos-rebuild switch --flake .#<host>`| Apply system changes or updates |
## 📋 To-Do List
- [Enable multi-host functionality](https://codeberg.org/serenity-F/SerenityOS/milestone/145563)
- [Enable multi-user functionality](https://codeberg.org/serenity-F/SerenityOS/milestone/145563)
- [Provide a wiki for this config](https://codeberg.org/serenity-F/SerenityOS/milestone/145569)
- [Provide an installer ISO or script](https://codeberg.org/serenity-F/SerenityOS/milestone/145563)
## 📝 Dev Notes
For the purposes of authenticity and earnestness
- I will not rebase or squash any commits
- I will not remove any outdated branches
## 🤝 Contributing
While this is a personal configuration, suggestions and improvements are welcome!
- [Open an issue for bugs or questions](https://codeberg.org/serenity-F/SerenityOS/issues/new)
- [Submit PRs for improvements](https://codeberg.org/serenity-F/SerenityOS/pulls)
- [Share your own configs inspired by this setup](https://discord.com/users/875234828776247308)
## 📜 License
- MIT License: Feel free to use and modify as you wish.
## 📚 Learning Resources
- [NixOS Manual](https://nixos.org/manual/nixos/stable/)
- [Nix Pills](https://nixos.org/guides/nix-pills/)
- [Home Manager](https://nix-community.github.io/home-manager/)
- [Niri Flake](https://github.com/epireyn/niri-flake)
- [Stylix](https://stylix.danth.me/)
## 🙋 Attributions
### Artwork
- [Helvetica Blanc](https://helveticablanc.com/)
- [Vincent Van Gogh](https://en.wikipedia.org/wiki/Almond_Blossoms/)
### Code
- [V3rm1n](https://codeberg.org/v3rm1n/dotfiles/)
- [Sashanoraa](https://codeberg.org/sashanoraa/nixcfg/)
- [Quantenzitrone](https://codeberg.org/quantenzitrone/nixos-config/)
<div align="center">
<br>
_Built with 🩵 and lots of ☕_
**[⭐ Star this repo](https://codeberg.org/Serenity-F/SerenityOS) if you found it helpful!**
</div>