Repository: QuTech-Delft/libqasm (language: python)

Issue:
[CQT-135] Update README
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.


Discussion / hints:
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).

Fix patch:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3d7f4dd1..d96f7200 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [ 0.6.7 ] - [ 2024-05-30 ]
+
+### Added
+- `pyproject.toml`.
+- GitHub pages.
+
+### Changed
+- Fix building of tests in Conan profiles and `setup.py`.
+- Fix Python MacOS/x64 (with Python > 3.11) packages.
+- Fix deserialization of CBOR strings.
+
+### Removed
+- Python 3.8 packages generation.
+
 ## [ 0.6.6 ] - [ 2024-05-14 ]
 
 ### Added
@@ -26,8 +40,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 ### Changed
-- Updated emscripten compilation flags.
-- Changed GitHub Actions `js-emscripten-wasm` job to work with `deno` instead of `node`.
+- Update emscripten compilation flags.
+- Change GitHub Actions `js-emscripten-wasm` job to work with `deno` instead of `node`.
 
 ### Removed
 
@@ -37,7 +51,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 ### Changed
-- Fixed CMake install.
+- Fix CMake install.
 - `generate_antlr_parser.py` writes output include files in a given `include` folder. 
 
 ### Removed
diff --git a/doc/src/dev-guide/cpp.md b/doc/src/dev-guide/cpp.md
index e0e164b9..2493f060 100644
--- a/doc/src/dev-guide/cpp.md
+++ b/doc/src/dev-guide/cpp.md
@@ -6,7 +6,7 @@ The following line will also build and cache the `libqasm` Conan package.
 
 ```shell
 conan profile detect
-conan create --version 0.6.6 . -pr:a=tests-debug -b missing
+conan create --version 0.6.7 . -pr:a=tests-debug -b missing
 ```
 
 You can test the C++ binaries:
diff --git a/doc/src/user-guide/cpp.md b/doc/src/user-guide/cpp.md
index 45ee4fd4..ea552a78 100644
--- a/doc/src/user-guide/cpp.md
+++ b/doc/src/user-guide/cpp.md
@@ -2,9 +2,9 @@ libQASM can be requested as a Conan package from a `conanfile.py`.
 
 ```
 def build_requirements(self):
-    self.tool_requires("libqasm/0.6.6")
+    self.tool_requires("libqasm/0.6.7")
 def requirements(self):
-    self.requires("libqasm/0.6.6")
+    self.requires("libqasm/0.6.7")
 ```
 
 And then linked against from a `CMakeLists.txt`:
diff --git a/include/version.hpp b/include/version.hpp
index 78ec363b..797b5a27 100644
--- a/include/version.hpp
+++ b/include/version.hpp
@@ -2,7 +2,7 @@
 
 namespace cqasm {
 
-static const char *version{ "0.6.6" };
+static const char *version{ "0.6.7" };
 static const char *release_year{ "2024" };
 
 [[nodiscard]] [[maybe_unused]] static const char *get_version() {


Test patch:
diff --git a/emscripten/test_libqasm.ts b/emscripten/test_libqasm.ts
index 4cff743e..9172131a 100644
--- a/emscripten/test_libqasm.ts
+++ b/emscripten/test_libqasm.ts
@@ -8,7 +8,7 @@ wrapper().then(function(result: any) {
 
     try {
         let output = cqasm.get_version()
-        let expected_output = "0.6.6"
+        let expected_output = "0.6.7"
         console.log("\nThe version of libqasm compiled with emscripten is:", output);
         if (output !== expected_output) {
             console.log("\tExpected output:", expected_output)