From 5a6b42df3fed4a2700b02c6efdda39461cd8ee86 Mon Sep 17 00:00:00 2001 From: Eshan Roy Date: Tue, 17 Dec 2024 19:27:06 +0530 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20style(=5Fui*):=20core=20changes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 164 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 98 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index a4b78a2..7605a85 100644 --- a/README.md +++ b/README.md @@ -1,121 +1,153 @@ -# 🌌 Snigdha OS Arctic V +# 🌌 **Snigdha OS Arctic V** -Snigdha OS Arctic V is the latest iteration of **Snigdha OS**, a lightweight, highly customizable Linux distribution based on Arch Linux and the Linux Zen Kernel. This edition emphasizes a modern, smooth, and user-centric experience for everyday use and penetration testing. +Snigdha OS Arctic V is the latest iteration of **Snigdha OS**, a lightweight, highly customizable Linux distribution based on **Arch Linux** and the **Linux Zen Kernel**. This edition focuses on delivering a modern, smooth, and user-centric experience tailored for everyday use and penetration testing. ---- -## ✨ Features -- **πŸ› οΈ Tailored Toolset:** Comes preloaded with essential tools for penetration testing and security auditing. Add or remove tools as needed during installation or afterward. -- **πŸ”’ Enhanced Security:** Built with strict security configurations like SELinux, AppArmor, and minimal active services to reduce the attack surface. -- **⚑ Optimized Performance:** Powered by the Linux Zen Kernel for a faster and smoother experience, even on low-end hardware. -- **🎨 Customization Options:** Designed for users who love to tweak their systems. Fully supports GTK themes, icon packs, and other UI customizations. -- **πŸ“¦ Lightweight and Fast:** Minimal bloat, allowing you to install only what you need. -- **🌍 Open-Source Community:** A community-driven project promoting collaboration and innovation. +## ✨ **Key Features** ---- +- **πŸ› οΈ Tailored Toolset:** Preloaded with essential tools for penetration testing and security auditing. Add or remove tools during installation or later based on your needs. +- **πŸ”’ Enhanced Security:** Implements advanced security features like: + - **SELinux**: Mandatory access control for safeguarding sensitive data. + - **AppArmor**: Application isolation for better threat protection. + - **Minimal Active Services**: Reduces potential attack vectors to ensure a hardened system. +- **⚑ Optimized Performance:** Powered by the **Linux Zen Kernel**, which enhances responsiveness and reduces latency. Perfect for both low-end devices and high-performance setups. +- **🎨 Ultimate Customization:** Offers extensive UI customization with support for: + - **GTK Themes**: Choose from hundreds of themes for a unique desktop look. + - **Icon Packs**: Customize every corner of your desktop. + - **Window Manager (WM) Integration**: Easily switch between popular WMs like **i3**, **BSPWM**, and **Openbox**. +- **πŸ“¦ Lightweight & Modular:** Avoids unnecessary bloatware and allows you to install only what you need. +- **🌍 Open-Source Community:** Built and maintained by a collaborative community committed to innovation. -## πŸ“¦ Installation -### Requirements: -- **Processor:** 64-bit (x86\_64 or ARM64) -- **RAM:** 2 GB (4 GB recommended) -- **Storage:** 20 GB free disk space -- **Internet Connection:** Required for installation and updates +## πŸ“¦ **Installation Instructions** -### Steps: +### πŸ–₯️ **System Requirements** -1. Download the latest Snigdha OS Arctic V ISO from the [Releases](https://github.com/Snigdha-OS/snigdhaos-arctic/releases) page. -2. Create a bootable USB drive using tools like **Rufus**, **Etcher**, or `dd` (Linux). -3. Boot from the USB and follow the guided installation process. +- **πŸ’» Processor:** 64-bit (x86_64 or ARM64) +- **🧠 RAM:** 2 GB minimum (4 GB recommended) +- **πŸ’Ύ Storage:** 20 GB free disk space +- **🌐 Internet Connection:** Required for installation and updates -For detailed instructions, refer to the [Installation Guide](https://github.com/Snigdha-OS/snigdhaos-arctic/wiki/Installation-Guide). +### πŸš€ **Installation Steps** ---- +1. πŸ“₯ **Download:** Grab the latest **Snigdha OS Arctic V ISO** from the [Releases](https://github.com/Snigdha-OS/snigdhaos-arctic/releases) page. +2. πŸ”§ **Create Bootable Media:** Use tools like **Rufus**, **Etcher**, or `dd` (Linux) to create a bootable USB drive. +3. πŸ”„ **Boot and Install:** Boot from the USB drive and follow the guided installation process. Choose your preferred desktop environment, tools, and configurations. -## πŸ–ΌοΈ Screenshots +πŸ“š For detailed guidance, check out the [Installation Guide](https://github.com/Snigdha-OS/snigdhaos-arctic/wiki/Installation-Guide). ---- -## πŸ› οΈ Contributing -We welcome contributions from the community! Here's how you can get involved: +## πŸ“š **Documentation** -1. Fork the repository and clone it locally. -2. Create a branch for your feature or fix: `git checkout -b my-feature`. -3. Commit your changes and push them: `git push origin my-feature`. -4. Submit a pull request describing your changes. +Comprehensive documentation is available to help you explore and maximize your experience with **Snigdha OS Arctic V**. Here’s what’s included: -For more details, see our [Contributing Guidelines](https://github.com/Snigdha-OS/snigdhaos-arctic/blob/main/CONTRIBUTING.md). +- **Getting Started Guide**: Learn the basics of installing and setting up Snigdha OS. +- **Desktop Environment Customization**: Step-by-step instructions for personalizing your UI. +- **Troubleshooting**: Common issues and solutions. +- **Advanced Configurations**: Dive into kernel optimizations, WM/DM setups, and automation. ---- +Access the complete documentation [here](https://github.com/Snigdha-OS/snigdhaos-arctic/wiki). -## πŸ€– Development Workflow -### Setting Up the Environment: -- Ensure you have **Git**, **Archiso**, and **Python** installed on your system: +## πŸ› οΈ **Contributing** + +πŸŽ‰ Contributions from the community are always welcome! Here’s how you can get involved: + +1. πŸ”€ **Fork** the repository and clone it locally. +2. πŸ›€οΈ **Create** a branch for your feature or fix: `git checkout -b my-feature`. +3. πŸ’Ύ **Commit** your changes and **push** them: `git push origin my-feature`. +4. πŸ“¨ **Submit** a pull request describing your changes. + +For detailed contribution guidelines, refer to the [Contributing Guidelines](https://github.com/Snigdha-OS/snigdhaos-arctic/blob/main/CONTRIBUTING.md). + + + +## πŸ€– **Development Workflow** + +### πŸ› οΈ **Setting Up the Environment** + +Ensure you have **Git**, **Archiso**, and **Python** installed on your system: ```bash sudo pacman -S git archiso python ``` -### Building the ISO: +### βš™οΈ **Building the ISO** -1. Clone the repository: +1. πŸ”½ Clone the repository: ```bash git clone https://github.com/Snigdha-OS/snigdhaos-arctic.git cd snigdhaos-arctic ``` -2. Customize your build by modifying files in these directories: +2. ✏️ Customize your build by modifying files in these directories: + - πŸ› οΈ `configs/`: Adjust system settings. + - 🎨 `themes/`: Tweak or add themes. + - πŸ“¦ `packages/`: Modify the package list to suit your needs. - - `configs/`: Adjust system settings. - - `themes/`: Tweak or add themes. - - `packages/`: Modify the package list to suit your needs. - -3. Build the ISO: +3. πŸ›‘ Build the ISO: ```bash sudo ./scripts/build-iso.sh ``` -4. Test the build using a virtual machine or a bootable USB drive. +4. πŸ–₯️ Test the build using a virtual machine or a bootable USB drive. ---- -## 🀝 Community & Support -Join our growing community to share ideas, report issues, or contribute to the development of SnigdhaOS-Arctic! +## 🀝 **Community & Support** -- **Issues:** Found a bug or have a suggestion? [Create an issue](https://github.com/Snigdha-OS/snigdhaos-arctic/issues). -- **Pull Requests:** Want to contribute? Submit a PR with your changes! -- **Discussions:** Join the conversation on [GitHub Discussions](https://github.com/Snigdha-OS/snigdhaos-arctic/discussions). +πŸ‘₯ Join our growing community to share ideas, report issues, or contribute to the development of Snigdha OS Arctic V! + +- 🐞 **Issues:** Found a bug or have a suggestion? [Create an issue](https://github.com/Snigdha-OS/snigdhaos-arctic/issues). +- ✍️ **Pull Requests:** Want to contribute? [Submit a PR](https://github.com/Snigdha-OS/snigdhaos-arctic/pulls)! +- πŸ’¬ **Discussions:** Join the conversation on [GitHub Discussions](https://github.com/Snigdha-OS/snigdhaos-arctic/discussions). Stay updated by following us on: -- **[Bluesky](https://bsky.app/@snigdhaos.org)** -- **[Twitter](https://twitter.com/snigdha_os)** +- 🐦 **[Twitter](https://twitter.com/snigdha_os)** +- 🌌 **[Bluesky](https://bsky.app/@snigdhaos.org)** ---- -## 🀝🏻 Developers -| Developer | Role | Profile Picture | Social Links | -| -------------- | ------------------ | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| **@eshanized** | Lead Developer | ![Eshanized](https://avatars.githubusercontent.com/u/148610067?v=4) | [GitHub](https://github.com/eshanized) β€’ [Twitter](https://twitter.com/eshanized) | -| **@alokified** | Web Infrastructure | ![Alokified](https://avatars.githubusercontent.com/u/ID?s=100) | [GitHub](https://github.com/alokified) β€’ [Twitter](https://twitter.com/alokified) | -| **@utkrshift** | WM/DM Developer | ![Utkrshift](https://avatars.githubusercontent.com/u/ID?s=100) | [GitHub](https://github.com/utkrshift) β€’ [LinkedIn](https://linkedin.com/in/utkrshift) | ---- -## 🀝🏻 Acknowledgments +## πŸ’Έ **Donate** -Special thanks to **Tonmoy Infrastructure** and **IXH International Co.** for sponsoring this project and making it possible. Additional gratitude to our contributors and users for shaping Snigdha OS Arctic V into a community-driven, innovative platform. +πŸ’– Support the development of Snigdha OS Arctic V by making a donation! Your contributions help us maintain and improve the project. ---- +### πŸ’΅ **Suggested Donation Amounts** -## πŸ“œ License +- **πŸ’° $10** - Helps with ongoing maintenance and security updates. +- **πŸ’° $25** - Supports the addition of new features and tools. +- **πŸ’° $50 or more** - Significant contributions go towards infrastructure and server costs. -This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details. +Donations can be made via: +- πŸ…ΏοΈ [PayPal](https://www.paypal.com/donate?hosted_button_id=EXAMPLEID) +- πŸ’³ [GitHub Sponsors](https://github.com/sponsors/yourusername) + +πŸ™ Thank you for supporting **Snigdha OS Arctic V**! + + + +## 🀝🏻 **Developers** + +| πŸ‘¨β€πŸ’» Developer | πŸ’Ό Role | 🌐 Social Links | +| ------------------ | -------------------- | -------------------------------------------------------------------------------------- | +| **@eshanized** | Lead Developer | [GitHub](https://github.com/eshanized) β€’ [Twitter](https://twitter.com/eshanized) | +| **@alokified** | Web Infrastructure | [GitHub](https://github.com/alokified) β€’ [Twitter](https://twitter.com/alokified) | +| **@utkrshift** | WM/DM Developer | [GitHub](https://github.com/utkrshift) β€’ [LinkedIn](https://linkedin.com/in/utkrshift) | + + +## πŸŽ‰ **Acknowledgments** + +πŸ™ Special thanks to **Tonmoy Infrastructure** and **IXH International Co.** for sponsoring this project and making it possible. Additional gratitude to our contributors and users for shaping Snigdha OS Arctic V into a community-driven, innovative platform. + + +## πŸ“œ **License** + +πŸ“„ This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details. \ No newline at end of file