From 7c6bb108172d1038af2fab44eeade8d00dae8999 Mon Sep 17 00:00:00 2001
From: Eshan Roy <m.eshanized@gmail.com>
Date: Mon, 16 Dec 2024 20:44:56 +0530
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs(=5Fnew):=20details=20and=20?=
 =?UTF-8?q?clarity?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)

diff --git a/README.md b/README.md
index e69de29..e028199 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,91 @@
+
+# Snigdha OS System Config
+
+Welcome to the Snigdha OS System Config repository! This repository contains the configuration files and scripts that manage and configure the underlying system settings for Snigdha OS.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Developers](#developers)
+- [Development Guide](#development-guide)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Overview
+
+Snigdha OS System Config is part of the Snigdha OS ecosystem, providing essential configuration files, scripts, and system settings that ensure a smooth and optimized user experience on Snigdha OS. This repository is intended for managing the system-level configurations of Snigdha OS and is crucial for both development and deployment processes.
+
+## Developers
+
+Below is the list of developers currently working on the Snigdha OS System Config:
+
+- **Eshan Roy(eshanized)** - Lead Developer, System Architect
+
+If you would like to contribute or join the team, feel free to reach out!
+
+## Development Guide
+
+### Prerequisites
+
+Before contributing, make sure you have the following:
+
+- A working environment with Snigdha OS installed.
+- A code editor (VSCode, Sublime Text, etc.).
+- Familiarity with shell scripting, configuration files, and Arch-based distributions.
+- Git for version control.
+
+### Setting Up the Development Environment
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Snigdha-OS/Snigdha OS-system-config.git
+   cd Snigdha OS-system-config
+   ```
+
+2. Ensure all dependencies are installed:
+   - Make sure you have access to Snigdha OS packages and configuration tools.
+   - You may need to install any required dependencies for testing scripts.
+
+3. Review and modify the configuration files as needed. Make sure you follow the configuration standards and best practices used in the project.
+
+### Contribution Guidelines
+
+- **Fork the repository** and clone your fork locally.
+- Create a new branch for each feature or bug fix:
+  ```bash
+  git checkout -b feature-name
+  ```
+- Make the necessary changes, test them locally, and commit them with meaningful commit messages.
+- Push your changes to your fork and create a pull request to the `main` branch.
+
+### Testing Changes
+
+Whenever you make changes to configuration scripts or system files, it’s important to test those changes. You can do this by:
+
+1. Applying the configuration changes locally.
+2. Ensuring the system boots and operates correctly with the new configurations.
+3. Running tests or checks based on the components you are modifying.
+
+### Code Style and Naming Conventions
+
+Please follow these guidelines to keep the codebase clean:
+
+- Use clear and descriptive names for scripts and variables.
+- Ensure comments are clear, especially for complex logic.
+- Use consistent formatting and indentation (2 spaces recommended).
+
+## Contributing
+
+We welcome contributions! Whether you're fixing a bug, adding a feature, or improving documentation, please follow these steps to contribute:
+
+1. Fork the repository and clone it locally.
+2. Create a branch for your changes.
+3. Submit a pull request with a clear description of the changes you’ve made.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+
+
+Thanks for contributing to Snigdha OS System Config!