[Doc] Fix documentation - Githubissues

QuTech-Delft / qx-simulator

QX Simulator

Other

16 stars 12 forks source link

[Doc] Fix documentation #152

Open rturrado opened 6 months ago

rturrado commented 6 months ago

The README.md just points to ReadTheDocs. But ReadTheDocs has been broken for a long time.

Align with whatever decision we take for libqasm on:

what information we want in the README.md, and what in a different place.
where we want to host that extra information: ReadTheDocs? Other?.
if it were ReadTheDocs, we have to fix them, because they have been broken for a very long time (at least for libqasm and OpenQL). We may be better off doing it from scratch. I think Fer Grooteman is the person who is maintaining the server where RtD is hosted, and the scripts that automate the publishing.