Skip to content

Add a readme with full installation steps and contributors onBoarding #10

@aniket866

Description

@aniket866

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions