From 076eaa57e7e5495fc0e34d30c7b673fb98177115 Mon Sep 17 00:00:00 2001 From: eshanized Date: Fri, 20 Dec 2024 00:10:25 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(docs):=20update=20documenta?= =?UTF-8?q?tion?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6664dd9 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# SnigdhaOS Assistant πŸš€ + +SnigdhaOS Assistant is a **Post Package Installer** designed to make setting up your Snigdha OS system a breeze! 🌟 Inspired by the post-installation tools of [Garuda Linux](https://garudalinux.org/), this utility simplifies the process of installing essential software, saving you time and effort. Whether you’re a power user or a newcomer, SnigdhaOS Assistant ensures your system is up and running with just a few clicks. πŸ’» + +## ✨ Features + +- **πŸš€ Automated Package Installation**: Get your system ready in no time with pre-configured installation options. +- **βš™οΈ Custom Configuration**: Tailor the assistant to install only the packages you need. +- **🎨 User-Friendly Interface**: Designed with simplicity and efficiency in mind. +- **πŸ’Ύ Lightweight and Fast**: Built specifically for Snigdha OS, ensuring seamless performance. + +## πŸ“¦ Installation + +Follow these steps to install SnigdhaOS Assistant: + +1. **Clone the Repository** πŸŒ€ + + ```bash + git clone https://github.com/Snigdha-OS/snigdhaos-assistant.git + ``` + +2. **Navigate to the Directory** πŸ“‚ + + ```bash + cd snigdhaos-assistant + ``` + +3. **Run the Installer** πŸ› οΈ + + ```bash + ./install.sh + ``` + +That’s it! πŸŽ‰ SnigdhaOS Assistant is now ready to use. + +## πŸš€ Usage + +Launch SnigdhaOS Assistant by running: + +```bash +snigdhaos-assistant +``` + +Follow the intuitive on-screen instructions to select and install your preferred packages. πŸ–±οΈ + +## 🀝 Contributing + +We’re always looking for ways to improve SnigdhaOS Assistant, and we’d love your help! 🌍 + +1. **Fork the Repository** 🍴 +2. **Create a New Branch** πŸ›€οΈ + + ```bash + git checkout -b feature-branch + ``` + +3. **Make Your Changes** ✏️ +4. **Commit Your Changes** βœ… + + ```bash + git commit -m "Description of your changes" + ``` + +5. **Push to Your Fork** πŸ“€ + + ```bash + git push origin feature-branch + ``` + +6. **Submit a Pull Request** πŸ”„ + + Head to the original repository and click on "New Pull Request" to propose your changes. + +## πŸ“œ License + +This project is licensed under the **MIT License**. For more details, see the [LICENSE](LICENSE) file. + +## πŸ™Œ Acknowledgements + +A huge shout-out to the team behind [Garuda Linux](https://garudalinux.org/) for inspiring this project. Your tools have set a benchmark for simplicity and functionality! 🌟 + +--- + +Stay tuned for updates and new features! Follow us on [GitHub](https://github.com/Snigdha-OS) to learn more about Snigdha OS and our other projects. πŸ’» +