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

[CQT-135] Update README #234

Merged
merged 1 commit into from
Aug 21, 2024
Merged

[CQT-135] Update README #234

merged 1 commit into from
Aug 21, 2024

Conversation

rturrado
Copy link
Contributor

This task is part of a greater task of updating the documentation for the whole of the cQASM tooling.

README files have to be updated. Some information needs to be added, modified, deleted, or moved to other documentation hosting systems (e.g., GitHub pages, ReadTheDocs, or Confluence).

The README files across the cQASM tooling should look consistent.

@rturrado rturrado linked an issue Jul 10, 2024 that may be closed by this pull request
@rturrado
Copy link
Contributor Author

Updated this PR to the latest changes from develop, including a new README.md and the GitHub pages.

Then:

  • Taken the previous changes in this PR and put them into the updated version, mostly in the GitHub pages.
  • Fixed links previously pointing to OpenSquirrel.
  • Replaced libqasm with libQASM wherever possible.
  • Added a User Guide Docker page (this was something missing from the previous README.md).

@rturrado rturrado changed the title Update README [CQT-135] Update README Aug 21, 2024
Copy link
Contributor

@elenbaasc elenbaasc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks all good, thanks!

Just a minor suggestion. Let me know when I need to approve again so I can follow-up soon.

doc/src/user-guide/user-guide.md Show resolved Hide resolved
elenbaasc
elenbaasc previously approved these changes Aug 21, 2024
@rturrado rturrado merged commit abf518e into develop Aug 21, 2024
20 checks passed
@rturrado rturrado deleted the 233-doc-update-readme branch August 21, 2024 15:32
rturrado added a commit that referenced this pull request Aug 26, 2024
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.

[Doc] Update README.md
2 participants