Update README for More Details and GSSoC Contribution Guidelines

[Rizvi-Faiz]

Issue: Update README for More Details and GSSoC Contribution Guidelines

Description

The current README file lacks detailed information about the project and contribution guidelines. This issue proposes an update to improve clarity and to ensure it follows the GSSoC contribution standards. The updated README should provide better guidance for contributors, especially those participating in GSSoC, and include all necessary project-related details.

Expected Updates

1. Project Overview: Provide a comprehensive overview of the project.
2. Installation Instructions: Add detailed steps on how to clone, set up, and run the project locally.
3. Tech Stack: Mention the technologies used in the project.
4. Contribution Guidelines: Include detailed contribution guidelines following GSSoC standards.
   • Link to the GSSoC Contribution Guidelines.
   • Describe how to make a pull request.
   • Guidelines for reporting issues.
5. Code of Conduct: Link or include a Code of Conduct file.
6. Project Structure: Describe the file and folder structure of the project.
7. Screenshots (if applicable): Provide screenshots of the app or project for better visualization.
8. Licensing: Add a section for the project’s license.
9. Contact Information: Add relevant contact or community details for potential contributors.
10. How to Get Started with GSSoC: Provide a section specifically for GSSoC contributors.

Tasks

• [ ] Add a detailed project overview.
• [ ] Update installation and setup instructions.
• [ ] Mention the tech stack used in the project.
• [ ] Add contribution guidelines for GSSoC participants.
• [ ] Include a Code of Conduct section or file.
• [ ] Add details about the project structure.
• [ ] Provide app screenshots (if applicable).
• [ ] Add license information.
• [ ] Include relevant contact information and community links.
• [ ] Add a section for "Getting Started with GSSoC".

Checklist

• [ ] The README provides clear project details.
• [ ] The contribution guidelines align with GSSoC standards.
• [ ] The README has been reviewed for completeness and clarity.
• [ ] Screenshots or visual aids are added where necessary.
• [ ] The README follows a consistent structure.

---

Priority: High
Type: Documentation Update
Status: Open for development

[Rizvi-Faiz]

@SanchitGeez can you please assign this issue to me and give it the gssoc-ext , hacktoberfest and the level labels.

[Rizvi-Faiz]

@SanchitGeez sir I think this is a level 3 issue because it serves as the foundation for any contributor, and resolving it is essential to ensure a stable base for future developments and contributions. If you don't mind can you please assign it to me with a level 3 label

[SanchitGeez]

@Rizvi-Faiz Assigned it....I am giving it level 2 as there are lot of things to add...but its still boilerplate and contrubuting guidellines are already added

[Rizvi-Faiz]

OK @SanchitGeez sir