Updated README to clarify purpose and key features of Classiq. #520
Conversation
README.md
Outdated
| @@ -5,11 +5,9 @@ | |||
| <img src="README_resources/classiq-logo.svg" width="300" height="150"> | |||
| </div> | |||
|
|
|||
| # Classiq | |||
| # Classiq: Quantum Programming Made Simple | |||
There was a problem hiding this comment.
Hello @Smoothengineer!
Thanks for your PR with these suggestions :)
Could you please change this line to: "Classiq: High-Level Quantum Modeling Language"
README.md
Outdated
| Your entry-point for creating & running quantum programs. | ||
|
|
||
| This repository holds a wide collection of quantum functions, algorithms, applications and tutorials built with Classiq. | ||
| Classiq provides a **powerful platform** for creating, running, and optimizing quantum programs. This repository hosts a **wide collection** of quantum functions, algorithms, applications, and tutorials, built using the Classiq SDK. Whether you're a researcher, developer, or student, Classiq helps you **simplify complex quantum workflows** and seamlessly transform your quantum logic into optimized circuits. With a user-friendly interface, you can model, simulate, and deploy quantum programs on various quantum hardware platforms. |
There was a problem hiding this comment.
Also, to better fit how we like to present our platform, I would adapt your original idea into:
"
Classiq provides a powerful platform for designing, optimizing, analyzing, and executing quantum programs. This repository hosts a comprehensive collection of quantum functions, algorithms, applications, and tutorials built using the Classiq SDK and our native Qmod language.
Whether you're a researcher, developer, or student, Classiq helps you simplify complex quantum workflows and seamlessly transform quantum logic into optimized circuits by leveraging our high-level functional design approach. A user-friendly interface allows you to model, simulate, visualize, and execute quantum programs across various quantum hardware platforms.
"
What do you think of that?
There was a problem hiding this comment.
It provides more info.
Nice
|
@Smoothengineer, thanks for helping us improve our README.md file! |
PR Description
This pull request enhances the README for the Classiq repository by improving formatting, adding clarifications, and rewording sections for better readability and coherence. The changes focus on:
Improving the clarity of example explanations and steps for using the SDK and platform.
Fixing minor formatting issues such as consistent use of headings, bullet points, and code blocks.
Enhancing the flow of the documentation to better guide users through the process of creating and running quantum programs.
Some notes
Please make sure that you placed the files in an appropriate folder
And that the files have indicative names.
Please note that Classiq runs automatic code linting, which may minorly alter some files.
pre-commit, you may runpre-commit install, and then at each commit, your files will be altered in a similar way