doc: add a readme

This commit is contained in:
eshanized
2025-01-11 22:43:25 +05:30
parent 3dabe4677c
commit 8e5f9cf673

83
readme.md Normal file
View File

@@ -0,0 +1,83 @@
# 🍭 SnigdhaOS Sugar Candy
[![License](https://img.shields.io/github/license/Snigdha-OS/snigdhaos-sugar-candy?color=blue)](LICENSE)
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)](#contributing)
[![Version](https://img.shields.io/badge/version-1.0-orange)](#)
[![Platform](https://img.shields.io/badge/platform-SnigdhaOS-purple)](#)
**SnigdhaOS Sugar Candy** is a 🌈 vibrant and cohesive QML-based theme for the SnigdhaOS operating system, designed to elevate your UI experience. 🎨✨
## ✨ Features
- 🎨 **Custom Components**: Includes a set of QML components tailored to provide a consistent look and feel across the system.
- 🖼️ **Backgrounds**: Offers a selection of visually stunning backgrounds that complement the theme.
- ⚙️ **Configuration**: Utilizes a `theme.conf` file for seamless customization and integration.
## 📥 Installation
1. **Clone the Repository**:
```bash
git clone https://github.com/Snigdha-OS/snigdhaos-sugar-candy.git
```
2. **Navigate to the Directory**:
```bash
cd snigdhaos-sugar-candy
```
3. **Copy Theme Files**:
Copy the contents to the appropriate themes directory in your system. For example:
```bash
cp -r * ~/.local/share/themes/
```
4. **Apply the Theme**:
Use your system's appearance settings to select and apply the "Sugar Candy" theme.
## 🎉 Usage
Once installed, the Sugar Candy theme will enhance your SnigdhaOS experience with its colorful design and elegant components. 🌟
## 🤝 Contributing
We 💖 contributions! Follow these steps to get involved:
1. 🍴 **Fork the Repository**: Click on the 'Fork' button at the top right of this page.
2. 🌿 **Create a New Branch**: Use `git checkout -b feature-branch-name`.
3. 🛠️ **Make Changes**: Implement your enhancements or fixes.
4. 📜 **Commit Changes**: Use `git commit -m 'Description of your changes'`.
5. 🚀 **Push to Branch**: Use `git push origin feature-branch-name`.
6. 🔀 **Create Pull Request**: Navigate to the original repository and click on 'New Pull Request'.
## 📜 License
This project is licensed under the **MIT License**. 📝 See the [LICENSE](LICENSE) file for more details.
## 🏆 Acknowledgements
Special thanks to the 💡 **SnigdhaOS community** for their support and contributions. 🙌
For more information, visit the [SnigdhaOS GitHub page](https://github.com/Snigdha-OS).
## 🌟 Show Your Support
If you ❤️ this project, give it a ⭐ on GitHub to show your appreciation!