📝 docs(_detail): update the readme

This commit is contained in:
Eshan Roy
2024-12-17 19:40:11 +05:30
parent fcc2fd8ff7
commit 904a3ba3ed

View File

@@ -1,3 +1,89 @@
<h1 align="center"> SNIGDHA OS</h1> # 🌟 Snigdha OS Assets
Welcome to the **official assets repository** for Snigdha OS! 🖥️
Snigdha OS is a **lightweight, highly customizable Linux distribution** based on Arch Linux and the Linux Zen Kernel. This repository contains all the graphical and branding resources that define the sleek, modern identity of Snigdha OS.
## Default readme!
## 📂 Repository Contents
Heres what youll find in this repository:
### 🎨 **Logos and Icons**
- Official Snigdha OS logos in various formats (SVG, PNG, etc.).
- Application and system icons designed for a clean and minimalist look.
### 🖼️ **Wallpapers**
- Beautiful, high-resolution wallpapers optimized for Snigdha OS desktops.
- A collection of official and community-contributed wallpapers to personalize your experience.
### 📢 **Banners and Branding**
- Web banners, headers, and promotional materials for use in websites, blogs, and presentations.
- Social media branding assets for platforms like Twitter, GitHub, and more.
### 📜 **Documentation**
- **Usage Guidelines**: How to properly use Snigdha OS branding materials in your projects.
- **Licensing Information**: Details about how you can share, adapt, and use these assets responsibly.
## 🚀 How to Use These Assets
1. **Clone the Repository**:
```bash
git clone https://github.com/Snigdha-OS/snigdhaos-assets.git
```
2. Use the assets in your projects or contributions to Snigdha OS.
3. Ensure compliance with the licensing terms mentioned below.
## 🤝 Contributing to Snigdha OS Assets
Wed love your help in improving and expanding the Snigdha OS assets! 🌱
### Steps to Contribute:
1. **Fork this Repository**.
2. **Create a New Branch**:
```bash
git checkout -b feature/your-feature-name
```
3. **Make Your Changes**: Add new assets or enhance existing ones.
4. **Commit Your Work**:
```bash
git commit -m "Add: Description of your changes"
```
5. **Push to Your Fork and Submit a Pull Request (PR)**.
🔗 Refer to the [Snigdha OS Branding Guidelines](./BRANDING_GUIDELINES.md) for contribution standards.
## 🧑‍💻 Developers and Maintainers
This repository and the Snigdha OS project are proudly developed and maintained by the **Snigdha OS Development Team** and contributors from around the world.
### Core Developers:
- **[Eshan Roy](https://github.com/eshanized/)** (Lead Developer) *Specializes in branding and UI/UX design.*
🎉 *We also thank our amazing open-source community for their contributions!*
## 📜 Licensing
All assets in this repository are licensed under the **Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)**.
### Key Points:
- ✔️ **Share and Adapt**: Feel free to use and modify the assets.
- 💡 **Credit Required**: Proper attribution must be given when using the assets.
- 🔄 **Share Alike**: If you modify the assets, you must distribute your contributions under the same license.
📖 For full licensing terms, see the [LICENSE](./LICENSE) file.
## 💬 Need Help or Have Questions?
Were here to assist!
🌐 **Website**: [snigdhaos.org](https://snigdhaos.org)
📧 **Email**: [support@snigdhaos.org](mailto:support@snigdhaos.org)
🐦 **Twitter**: [@SnigdhaOS](https://twitter.com/SnigdhaOS)
Maintained with ❤️ by **Tonmoy Infrastructure** and the **Snigdha OS Development Team** 🚀