tweak: updated repository files and presentation
This commit is contained in:
parent
6c01ed3a92
commit
2fdb1d8c69
7 changed files with 115 additions and 39 deletions
20
LICENSE
Normal file
20
LICENSE
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
|
||||
MIT No Attribution
|
||||
|
||||
Copyright 2025 Serenity-F
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
95
README.md
95
README.md
|
|
@ -1,22 +1,79 @@
|
|||
# Serenity OS
|
||||
<div align="center">
|
||||
|
||||
## CURRENTLY UNDERGOING A MASSIVE REBUILD
|
||||
<br>
|
||||
<br>
|
||||
# SerenityOS
|
||||
|
||||
## PLANNED FEATURES
|
||||
- SUPPORT FOR MULTIPLE HOSTS AND USERS
|
||||
- HOME-MANAGER
|
||||
- DENDRITIC STRUCTURE
|
||||
- THOROUGHLY COMMENTED
|
||||
- MAYBE A GUIDE AND WIKI?
|
||||
- STOP WRITING README IN ALL CAPS?
|
||||
<br>
|
||||
<br>
|
||||
_Declarative NixOS configuration with Flakes & Home Manager_
|
||||
|
||||
TODO:
|
||||
- FINISH DESKTOP SUPERMODULE
|
||||
- FINISH TERMINAL SUPERMODULE
|
||||
- IMPLEMENT ESSENTIAL FEATURES FROM `main` BRANCH
|
||||
- SWITCH ACTIVE SYSTEM TO `dendritic` BRANCH
|
||||
- THE FACTORY MUST EXPAND
|
||||
[](https://codeberg.org/v3rm1n/nix-dots/stars)
|
||||
[](https://nixos.org)
|
||||
[](https://codeberg.org/v3rm1n/nix-dots/src/branch/main/LICENSE)
|
||||
|
||||
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="600px" alt="Catppuccin Macchiato Palette" />
|
||||
|
||||
</div>
|
||||
|
||||
### ✨ Key Features
|
||||
|
||||
- 🎨 **Unified Theming** with Stylix
|
||||
- 🪟 **Niri** with ReGreet session management
|
||||
- 🏠 **Home Manager** for declarative user environments
|
||||
- 📦 **Modular Architecture** for easy customization
|
||||
|
||||
## 💻 System Information
|
||||
|
||||
### Software Stack
|
||||
|
||||
| Component | Implementation |
|
||||
| ------------------ | ------------------------------------ |
|
||||
| **OS** | NixOS Unstable |
|
||||
| **Display Server** | Wayland |
|
||||
| **Window Manager** | Niri + ReGreet |
|
||||
| **Desktop** | Noctalia |
|
||||
| **Terminal** | Kitty |
|
||||
| **Shell** | Fish |
|
||||
| **Editor** | Helix |
|
||||
| **Browser** | Firefox |
|
||||
| **File Manager** | Yazi |
|
||||
| **Theme** | Stylix |
|
||||
| **Filesystem** | Ext4 + ZFS |
|
||||
|
||||
## 🛠️ System Management
|
||||
|
||||
### Common Commands
|
||||
|
||||
| Command | Description |
|
||||
| ------------------------------------------ | -------------------------------------------------- |
|
||||
| `git add --all && git commit -m "<message>"`| Save system changes to git tree |
|
||||
| `nix flake update` | Update all flake inputs manually |
|
||||
| `nix flake check` | Validate flake configuration |
|
||||
| `sudo nixos-rebuild switch --flake .#<host>`| Apply system changes |
|
||||
| `sudo nixos-rebuild test --flake .#<host>` | Test configuration without switching |
|
||||
| `sudo nixos-rebuild boot --flake .#<host>` | Build and set for next boot |
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
While this is a personal configuration, suggestions and improvements are welcome!
|
||||
|
||||
- Open an issue for bugs or questions
|
||||
- Submit PRs for improvements
|
||||
- Share your own configs inspired by this setup
|
||||
|
||||
## 📜 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 Manual](https://nix-community.github.io/home-manager/)
|
||||
- [Niri flake](https://github.com/epireyn/niri-flake)
|
||||
- [Stylix Documentation](https://stylix.danth.me/)
|
||||
|
||||
<div align="center">
|
||||
|
||||
_Built with ❤️ and lots of ☕_
|
||||
|
||||
**[⭐ Star this repo](https://codeberg.org/Serenity-F/SerenityOS) if you found it helpful!**
|
||||
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -11,37 +11,36 @@ in
|
|||
{
|
||||
|
||||
# nixos module declaration
|
||||
flake.modules.nixos.modulename = { ... }: {
|
||||
flake.modules.nixos.modulename =
|
||||
|
||||
# list of modules to import
|
||||
modules = [
|
||||
self.modules.nixos.othermodule
|
||||
];
|
||||
{ ... }:
|
||||
|
||||
# for home manager functionality
|
||||
imports = [ inputs.home-manager.nixosModules.home-manager ];
|
||||
{
|
||||
|
||||
# nixos options
|
||||
programs = {
|
||||
foo = {
|
||||
bar = true;
|
||||
};
|
||||
};
|
||||
# for home manager functionality
|
||||
imports = [ inputs.home-manager.nixosModules.home-manager ];
|
||||
|
||||
# home manager options
|
||||
home-manager.users.${username} = {
|
||||
|
||||
# program settings
|
||||
# nixos options
|
||||
programs = {
|
||||
|
||||
foo = {
|
||||
bar = true;
|
||||
};
|
||||
};
|
||||
|
||||
# home manager options
|
||||
home-manager.users.${username} = {
|
||||
|
||||
# program settings
|
||||
programs = {
|
||||
|
||||
foo = {
|
||||
bar = true;
|
||||
};
|
||||
|
||||
};
|
||||
|
||||
};
|
||||
|
||||
};
|
||||
|
||||
};
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue