search

QuTech-Delft / OpenSquirrel

A flexible (Python-based) quantum program compiler
Apache License 2.0
4 stars 1 forks source link

[CQT-63] Update README #254

Closed rturrado closed 1 day ago

rturrado commented 1 month ago

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 commented 1 month ago

I think many of the things we have in the README.md at the moment will have to go to GitHub Pages.

I propose to finish the documentation (README plus GitHub Pages) for libqasm, then mimic it here.

README could contain:

GitHub Pages could contain:

elenbaasc commented 1 month ago

I think many of the things we have in the README.md at the moment will have to go to GitHub Pages.

I propose to finish the documentation (README plus GitHub Pages) for libqasm, then mimic it here.

README could contain:

  • an Introduction,
  • a Getting Started section with some basic examples,
  • a link to the GitHub Pages, and
  • some minor sections such as Licensing, Authors...

GitHub Pages could contain:

  • a Home,
  • a User Guide,
  • a Developer Guide,
  • an About section with Release Notes, Contributing, Authors, Licensing...

I would say this README is close to being finished for now. Note that it is meant for Contributing developers, so all the information they need to start and contribute should be in there, i.e., I don't think too much information should be left out and be transferred to the User documentation (hosted through GitHub pages). I do agree that most details should be in the User documentation and the README should remain concise.