Skip to content

docs: improve README with setup and contribution guide#11

Open
Vaishnavi10706 wants to merge 1 commit intoPlanetRead:mainfrom
Vaishnavi10706:docs/readme-update
Open

docs: improve README with setup and contribution guide#11
Vaishnavi10706 wants to merge 1 commit intoPlanetRead:mainfrom
Vaishnavi10706:docs/readme-update

Conversation

@Vaishnavi10706
Copy link
Copy Markdown

Description

This PR improves the README.md by adding a well-structured and comprehensive guide for contributors and new developers.

Changes Made

  • Added project overview and tech stack
  • Included prerequisites and installation steps
  • Documented environment setup using .env.example
  • Added instructions to run the project (Expo)
  • Provided clear folder structure
  • Included contribution guidelines and PR process
  • Improved overall formatting and readability

Purpose

The goal of this update is to make the project easier to understand, set up, and contribute to, especially for new developers.

Testing

  • Verified setup steps locally
  • Ensured instructions are clear and easy to follow

Additional Notes

  • No code changes were made
  • Only documentation improvements

Please let me know if any additional details or sections should be included.

@Vaishnavi10706
Copy link
Copy Markdown
Author

@Asp-irin @JiyaGupta-cs Can you please review it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant