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

docs: enhance README with detailed installation guide and features #1194

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

Conversation

crStiv
Copy link

@crStiv crStiv commented Jan 12, 2025

Description:

  • Add Key Features section highlighting main capabilities
  • Improve installation instructions with GPU/CPU variants
  • Add system requirements and Python version compatibility
  • Include version compatibility matrix
  • Enhance readability of installation options
  • Update documentation structure for better navigation

This commit aims to make the README more informative and user-friendly,
helping new contributors and users better understand the project's
capabilities and requirements.

Copy link

cla-bot bot commented Jan 12, 2025

Thank you for your pull request. We require contributors to sign our Contributor License Agreement / Terms and Conditions, and we don't seem to have the users @crStiv on file. In order for us to review and merge your code, please sign:

  • For individual contribution: our CLA
  • for Bounty submission, if you are an individual: our T&C
  • for Bounty submission, if you are a company: our T&C
    to get yourself added.

If you already signed one of this document, just wait to be added to the bot config.

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