diff --git a/README.md b/README.md index f4fe412..32b9456 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# Snigdha OS GNOME Config +# Snigdha OS GNOME Config 🌟 -This repository contains the configuration files for GNOME, specifically tailored for Snigdha OS. It includes custom GNOME settings, themes, extensions, and other optimizations to provide a smooth and user-friendly experience on Snigdha OS. +This repository contains the configuration files for **GNOME**, specifically tailored for **Snigdha OS**. It includes custom GNOME settings, themes, extensions, and other optimizations designed to offer a smooth, modern, and user-friendly experience on Snigdha OS. 🚀 Whether you're a developer, designer, or casual user, this configuration is built to enhance your desktop environment. -## Features +## Features ✨ -- **Custom GNOME Theme**: A sleek, modern theme designed for a visually appealing user interface. -- **Optimized Settings**: Pre-configured settings to improve performance and usability, customized for the Snigdha OS environment. -- **Extensions**: A collection of GNOME Shell extensions to enhance functionality and streamline workflow. -- **Customization**: Easily customizable settings to allow users to tweak the desktop environment to their preferences. +- **Custom GNOME Theme** 🎨: A sleek, modern theme with carefully crafted aesthetics that provide a clean and visually appealing user interface for a productive work environment. +- **Optimized Settings** ⚡: Pre-configured settings to improve performance, efficiency, and usability, specifically designed for Snigdha OS. These settings optimize your desktop’s responsiveness and ensure a fluid experience. +- **Extensions** 🧩: A collection of carefully selected GNOME Shell extensions to boost functionality, customize your workflow, and make your desktop even more powerful. +- **Customization** 🔧: Fully customizable settings that allow users to tweak every aspect of their desktop experience. You can adjust themes, tweak performance options, and customize shortcuts to your liking. -## Installation +## Installation 🛠️ To install the custom GNOME configurations from this repository, follow these steps: @@ -22,35 +22,58 @@ cd snigdhaos-gnome-config ### 2. Apply the configurations: -Run the provided installation script to apply the GNOME configurations. +Run the provided installation script to apply the GNOME configurations: ```bash bash install.sh ``` +This will automatically set up the theme, extensions, and system settings designed for Snigdha OS. + ### 3. Optional - Install GNOME Extensions: -If you want to install the GNOME Shell extensions from the repository, use the following command: +If you wish to install the GNOME Shell extensions from the repository, use the following command: ```bash gnome-extensions install extensions/*.gs ``` -## Usage +These extensions will give you more functionality and integration within the GNOME desktop environment. -Once the configuration is applied, you can customize further through the GNOME Tweaks application or manually adjust settings within `~/.config/gnome` or `/usr/share/gnome`. +## Usage 🖥️ -## Contributing +Once the configuration is applied, you can further customize your desktop environment using the **GNOME Tweaks** application. You can also manually adjust settings within the following directories: + +- `~/.config/gnome` – for personal configurations. +- `/usr/share/gnome` – for system-wide settings. + +For advanced users, you can also tweak configurations using the command line to achieve maximum flexibility. + +## Contributing 🤝 We welcome contributions to improve this repository! If you have suggestions, bug reports, or improvements, feel free to open an issue or submit a pull request. -1. Fork the repository. -2. Create a branch for your changes (`git checkout -b feature/your-feature`). -3. Make your changes. -4. Commit your changes (`git commit -am 'Add new feature'`). -5. Push to the branch (`git push origin feature/your-feature`). -6. Create a pull request. +Here’s how you can contribute: -## License +1. **Fork the repository** 🍴: Click the "Fork" button on GitHub to create your own copy of the repository. +2. **Create a branch for your changes**: (`git checkout -b feature/your-feature`) +3. **Make your changes** ✍️: Implement your bug fixes or new features. +4. **Commit your changes**: (`git commit -am 'Add new feature'`) +5. **Push to the branch**: (`git push origin feature/your-feature`) +6. **Create a pull request** 💥: Submit your changes for review and merging into the main project. -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +We encourage all contributors to follow the **code of conduct** and ensure that their contributions align with the goals of Snigdha OS. + +## Author & Maintainer ✍️ + +This repository is maintained by the **Snigdha OS Team**. + +- **Author**: [Eshan Roy | eshanized](https://github.com/eshanized) (or "Snigdha OS Team") +- **Email**: [m.eshanized@gmail.com](mailto:your.email@example.com) +- **GitHub Profile**: [@eshanized](https://github.com/eshanized) + +If you have any questions, need help, or would like to contribute, feel free to reach out! + +## License 📝 + +This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details. This means you’re free to use, modify, and distribute the project, but we would appreciate it if you credit the project when using it. \ No newline at end of file