📝 docs: update the readme file followed by @eshanized

This commit is contained in:
RiO
2024-12-19 21:11:18 +05:30
parent 7f5f2a7373
commit 796fd4a3fc

86
README.md Normal file
View File

@@ -0,0 +1,86 @@
# Snigdha OS Plasma Config
This repository contains the customized KDE Plasma configuration files for **Snigdha OS**. These settings are tailored to provide a seamless, minimal, and user-centric desktop experience, aligning with the philosophy of Snigdha OS.
## Features
- **Minimal and Clean UI**: Carefully crafted settings to reduce clutter and focus on usability.
- **Custom Themes and Colors**: Aesthetic designs with a focus on readability and elegance.
- **Optimized Workflows**: Preconfigured shortcuts, widgets, and layouts for enhanced productivity.
- **Pre-tweaked Defaults**: Fine-tuned system preferences for a smooth out-of-the-box experience.
- **Snigdha OS Branding**: Includes exclusive wallpapers, splash screens, and other visual elements.
## Installation
To apply the Snigdha OS Plasma Config:
1. Clone this repository:
```bash
git clone https://github.com/Snigdha-OS/snigdhaos-plasma-config.git
```
2. Backup your existing Plasma configuration:
```bash
mkdir -p ~/.config/plasma-backup
cp -r ~/.config/* ~/.config/plasma-backup/
```
3. Replace your current Plasma configuration:
```bash
cp -r snigdhaos-plasma-config/* ~/.config/
```
4. Restart your Plasma session to apply the changes:
```bash
kquitapp5 plasmashell && kstart5 plasmashell
```
## Customization
You can further customize the settings by navigating to:
- **System Settings** > Appearance
- **System Settings** > Shortcuts
- **System Settings** > Window Management
## Developers
- **d3v1l0n**: Primary developer and maintainer of Snigdha OS Plasma Config.
- **Snigdha OS Team**: Contributions to design, testing, and optimizations.
## Contributing
We welcome contributions to improve the Snigdha OS Plasma Config. To contribute:
1. Fork the repository.
2. Create a feature branch:
```bash
git checkout -b feature/your-feature
```
3. Commit your changes:
```bash
git commit -m "Add your feature description"
```
4. Push your branch:
```bash
git push origin feature/your-feature
```
5. Create a Pull Request.
## License
This project is licensed under the [MIT License](LICENSE).
## Credits
- **Snigdha OS Team** for their dedication to creating a superior Linux experience.
- Powered by **[TONMOY INFRASTRUCTURE](https://www.tonmoy.com)**.
## Feedback and Support
If you encounter issues or have suggestions for improvement, please open an [issue](https://github.com/Snigdha-OS/snigdhaos-plasma-config/issues) or contact us through our [community channels](https://forum.snigdhaos.org/).
<p align="center">
<b>Snigdha OS - Your Gateway to a Minimal and Powerful Linux Experience</b>
</p>