diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d6de57b --- /dev/null +++ b/LICENSE @@ -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. + diff --git a/README.md b/README.md index bca5993..bf82834 100755 --- a/README.md +++ b/README.md @@ -1,22 +1,79 @@ -# Serenity OS +
- ## CURRENTLY UNDERGOING A MASSIVE REBUILD -
-
+# 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? -
-
+_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 +[![Stars](https://img.shields.io/gitea/stars/v3rm1n/nix-dots?gitea_url=https%3A%2F%2Fcodeberg.org&color=F5BDE6&labelColor=303446&style=for-the-badge&logo=starship&logoColor=F5BDE6)](https://codeberg.org/v3rm1n/nix-dots/stars) +[![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/v3rm1n/nix-dots/src/branch/main/LICENSE) + +Catppuccin Macchiato Palette + +
+ +### ✨ 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 ""`| 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 .#`| Apply system changes | +| `sudo nixos-rebuild test --flake .#` | Test configuration without switching | +| `sudo nixos-rebuild boot --flake .#` | 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/) + +
+ +_Built with ❤️ and lots of ☕_ + +**[⭐ Star this repo](https://codeberg.org/Serenity-F/SerenityOS) if you found it helpful!** + +
diff --git a/assets/repository/boilerplate.nix b/assets/repository/boilerplate.nix index 682e9ee..e4fd66e 100644 --- a/assets/repository/boilerplate.nix +++ b/assets/repository/boilerplate.nix @@ -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; + }; + + }; }; }; - }; - } diff --git a/assets/repository/screenshot-desktop1.png b/assets/repository/screenshot-desktop1.png deleted file mode 100644 index e69de29..0000000 diff --git a/assets/repository/screenshot-desktop2.png b/assets/repository/screenshot-desktop2.png deleted file mode 100644 index e69de29..0000000 diff --git a/assets/repository/screenshot-fetch.png b/assets/repository/screenshot-fetch.png deleted file mode 100644 index e69de29..0000000 diff --git a/assets/repository/screenshot-helix.png b/assets/repository/screenshot-helix.png deleted file mode 100644 index e69de29..0000000