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-138] Update README #160

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

[CQT-138] Update README #160

wants to merge 4 commits into from

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
README.md Outdated Show resolved Hide resolved
Copy link

@juanboschero juanboschero left a comment

Choose a reason for hiding this comment

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

Everything looking good! One minor change.

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

Do not merge this task yet.

We need to replicate the work done on libqasm:

  • Set up a documentation framework based on a README file plus GitHub pages.
  • Update the contents in both the README file and the GitHub pages.

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