Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving README Formatting and Clarity for Increased Accessibility #104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

faeezshaikh
Copy link

This pull request aims to improve the readability and standardization of the project's README file, in order to make it more accessible and user-friendly for potential contributors and users.

  • Updated the README file to include more detailed information about the ML models included in the project.
  • Added instructions for installing and setting up the project in a virtual environment.
  • Added instructions for running each individual project.
  • Made sure all links are working and lead to the appropriate pages.
  • Checked the formatting and style of the README file to ensure it is consistent with other open source projects.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Faeez Shaikh seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@faeezshaikh
Copy link
Author

faeezshaikh commented Apr 1, 2023

I have signed the CLA. Not sure why its not updating here.

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.

None yet

2 participants