docs: enhance README with detailed installation guide and features #1194
Conversation
|
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:
If you already signed one of this document, just wait to be added to the bot config. |
|
Hello @crStiv , thank you for your contribution can you sign our cla (cc @aquint-zama ) and I let @yuxizama who is in charge of our documentation to review your commit. |
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
|
@aquint-zama @BourgerieQuentin I suppose the CLA was subscribed? |
indeed it's all good, you could see the label on the PR automatically added by our CLA bot |
README.md
Outdated
| - 📊 Built-in performance analysis tools | ||
| - 🔄 Seamless integration with existing Python code | ||
|
|
||
| ### System Requirements |
There was a problem hiding this comment.
I would just recommend moving ### System Requirments under ##Getting Started.
The rest is all good to me.
README.md
Outdated
|
|
||
| | Concrete Version | Python Version | CUDA Support | | ||
| |-----------------|----------------|--------------| | ||
| | 2.0.0 | 3.8 - 3.11 | ≥ 11.8 | |
There was a problem hiding this comment.
I think we support 3.12 as well
There was a problem hiding this comment.
I think we support 3.12 as well
@bcm-at-zama made an update
Description:
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.