Skip to content

Improve README with installation and contributor-friendly instructions#17

Open
urvashi-agrawal-dev wants to merge 2 commits into
humanai-foundation:mainfrom
urvashi-agrawal-dev:improve-readme-installation
Open

Improve README with installation and contributor-friendly instructions#17
urvashi-agrawal-dev wants to merge 2 commits into
humanai-foundation:mainfrom
urvashi-agrawal-dev:improve-readme-installation

Conversation

@urvashi-agrawal-dev

Copy link
Copy Markdown

This PR improves the root README to make the project easier to understand and use for new contributors.

Changes include:

  • Added environment setup using virtual environments
  • Documented installation steps and dependencies
  • Clarified dataset expectations and input format
  • Added a typical workflow and contributing guidelines

These changes focus on improving onboarding without modifying core functionality.

@urvashi-agrawal-dev

Copy link
Copy Markdown
Author

Hi! This PR improves the root README to make the project more beginner-friendly by adding setup, usage, and contribution instructions.
Please let me know if any changes are needed.

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