Skip to content

Update README with project details and setup instructions#32

Open
TarunaJ2006 wants to merge 2 commits into
theapprenticeproject:mainfrom
TarunaJ2006:main
Open

Update README with project details and setup instructions#32
TarunaJ2006 wants to merge 2 commits into
theapprenticeproject:mainfrom
TarunaJ2006:main

Conversation

@TarunaJ2006
Copy link
Copy Markdown

Added improved README documentation including:

  • project overview
  • Python environment setup instructions
  • dependency installation guidance
  • contribution workflow steps
  • repository structure details
  • contributor guidelines

Closes #31

Added project overview, setup instructions, contribution guidelines, and repository structure details.
Copy link
Copy Markdown

@rohansaini-02 rohansaini-02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @TarunaJ2006, thanks for improving the documentation
I noticed the clone command points to your personal fork (TarunaJ2006/C4GT_2026) instead of the official upstream repo. Changing the URL to https://github.com/theapprenticeproject/C4GT_2026.git will ensure new contributors clone the correct repository.

@TarunaJ2006
Copy link
Copy Markdown
Author

Thanks for reviewing the PR. I have updated the clone URL to point to the official upstream repository.

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.

Improve setup instructions and contribution workflow documentation

2 participants