Skip to content

Commit

Permalink
📝 docs(docs): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eshanized committed Dec 19, 2024
1 parent 396c5e8 commit 076eaa5
Showing 1 changed file with 85 additions and 0 deletions.
85 changes: 85 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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. 💻

0 comments on commit 076eaa5

Please sign in to comment.