Issue: Add README with Installation & Contributor Onboarding
Description
The repository currently lacks a comprehensive README.md. This makes it difficult for new developers to understand how to set up the project and start contributing.
Tasks
- Create a
README.md file
- Add full installation steps
- Include project setup instructions
- Document dependencies and requirements
- Add contributor onboarding guidelines
Expected Sections in README
- Project Overview
- Prerequisites
- Installation Steps
- Running the Project
- Folder Structure
- Contribution Guidelines
- Code Style / Standards
- How to Submit PRs
Additional Notes
- Keep instructions concise and structured
- Use proper markdown formatting
Issue: Add README with Installation & Contributor Onboarding
Description
The repository currently lacks a comprehensive
README.md. This makes it difficult for new developers to understand how to set up the project and start contributing.Tasks
README.mdfileExpected Sections in README
Additional Notes