mirror of
https://github.com/Snigdha-OS/snigdhaos-blackbox.git
synced 2025-09-21 20:15:02 +02:00
141 lines
3.6 KiB
Markdown
141 lines
3.6 KiB
Markdown
# Snigdha OS Blackbox 🚀
|
|
|
|
Snigdha OS Blackbox is the official tools installer for Snigdha OS, a lightweight and highly customizable Arch-based Linux distribution. This installer simplifies the process of setting up your Snigdha OS environment by providing a curated selection of essential tools and utilities.
|
|
|
|
|
|
|
|
## 🌟 Features
|
|
|
|
- **🔧 Comprehensive Tool Selection**: Install a wide range of tools for development, system utilities, and more, optimized for Snigdha OS.
|
|
- **✨ User-Friendly Interface**: Intuitive and easy to use for both beginners and advanced users.
|
|
- **📦 Seamless Integration**: Ensures installed tools work perfectly within the Snigdha OS ecosystem.
|
|
- **⚡ Lightning-Fast**: Designed to operate efficiently without compromising on speed or performance.
|
|
|
|
|
|
|
|
## 📁 Repository Structure
|
|
|
|
The repository is organized as follows:
|
|
|
|
```
|
|
snigdhaos-blackbox/
|
|
├── .github/ # GitHub-specific files, including workflows and issue templates
|
|
├── build/ # Build output directories
|
|
├── qt/ # Qt-related source files for the installer GUI
|
|
├── usr/ # User-related scripts and resources
|
|
├── .gitignore # Specifies files to be ignored by Git
|
|
├── CMakeLists.txt # CMake build configuration file
|
|
├── CODE_OF_CONDUCT.md # Code of conduct for contributors
|
|
├── LICENSE # Licensing information
|
|
├── README.md # This README file
|
|
├── config.sh # Configuration script
|
|
└── push.sh # Deployment script
|
|
```
|
|
|
|
|
|
|
|
## 🛠️ Technologies Used
|
|
|
|
- **Languages**: C++, Shell Scripting
|
|
- **Frameworks**: Qt for GUI development
|
|
- **Build Systems**: CMake for build configuration, Makefile for build automation
|
|
- **Version Control**: Git for source code management
|
|
|
|
|
|
|
|
## 🚀 Installation
|
|
|
|
1. **Clone the Repository**:
|
|
|
|
```bash
|
|
git clone https://github.com/Snigdha-OS/snigdhaos-blackbox.git
|
|
```
|
|
|
|
2. **Navigate to the Directory**:
|
|
|
|
```bash
|
|
cd snigdhaos-blackbox
|
|
```
|
|
|
|
3. **Build and Install**:
|
|
|
|
```bash
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
sudo make install
|
|
```
|
|
|
|
📝 These commands will build the installer and install it on your system.
|
|
|
|
|
|
|
|
## 🖥️ Usage
|
|
|
|
Launch Snigdha OS Blackbox from your application menu or execute the following in the terminal:
|
|
|
|
```bash
|
|
snigdhaos-blackbox
|
|
```
|
|
|
|
Follow the on-screen instructions to explore and install tools.
|
|
|
|
|
|
|
|
## 🤝 Developers
|
|
|
|
- **Snigdha OS Team**
|
|
- **Lead Developer**: [Eshan Roy](https://github.com/eshanized/)
|
|
|
|
👋 Want to contribute? Check the [Contributing Section](#-contributing).
|
|
|
|
|
|
|
|
## 🤓 Contributing
|
|
|
|
We welcome all contributions! Here's how you can help:
|
|
|
|
1. **Fork the Repository**:
|
|
Click the "Fork" button on the GitHub page to create a personal copy.
|
|
|
|
2. **Create a Branch**:
|
|
```bash
|
|
git checkout -b feature-name
|
|
```
|
|
|
|
3. **Make Changes**:
|
|
Implement new features, fixes, or improvements.
|
|
|
|
4. **Commit Changes**:
|
|
```bash
|
|
git commit -m "Description of changes"
|
|
```
|
|
|
|
5. **Push to GitHub**:
|
|
```bash
|
|
git push origin feature-name
|
|
```
|
|
|
|
6. **Submit a Pull Request**:
|
|
Navigate to the original repository and click "New Pull Request."
|
|
|
|
|
|
|
|
## 📜 License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
|
|
|
|
|
|
|
## 📬 Contact
|
|
|
|
- **Email**: [hello@snigdhaos.org](mailto:hello@snigdhaos.org)
|
|
- **Website**: [Snigdha OS Official Website](https://snigdhaos.org/)
|
|
- **GitHub Organization**: [Snigdha OS](https://github.com/Snigdha-OS)
|
|
|
|
🌟 Follow our journey and contribute to the growth of Snigdha OS!
|
|
|
|
|
|
|
|
✨ Happy Developing! |