Docs Update (#100)

* toml additions/corrections * readmes corrections * github pages link
HQSquantumsimulations · Dec 21, 2023 · 72b9cc8 · 72b9cc8
1 parent b48ad01
commit 72b9cc8
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 62 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,6 +3,7 @@ members = [
     "roqoqo-qasm",
     "qoqo_qasm",
 ]
+resolver = "2"
 
 [profile.release]
 lto = true

diff --git a/README.md b/README.md
@@ -11,11 +11,11 @@ This repository contains two components:
 
 ## qoqo-qasm
 
-[![Documentation Status](https://readthedocs.org/projects/qoqo-qasm/badge/?version=latest)](https://qoqo-qasm.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://img.shields.io/badge/docs-read-blue)](https://hqsquantumsimulations.github.io/qoqo_qasm/)
 [![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qasm/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qasm/actions)
 [![PyPI](https://img.shields.io/pypi/v/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
-![PyPI - License](https://img.shields.io/pypi/l/qoqo_qasm)
 [![PyPI - Format](https://img.shields.io/pypi/format/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
+![Crates.io](https://img.shields.io/crates/l/qoqo-qasm)
 
 Qasm interface for the qoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
 

diff --git a/qoqo_qasm/Cargo.toml b/qoqo_qasm/Cargo.toml
@@ -3,7 +3,8 @@ name = "qoqo_qasm"
 version = "0.9.3"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
-edition = "2018"
+edition = "2021"
+rust-version = "1.56"
 categories = ["science", "simulation"]
 readme = "README.md"
 homepage = "https://github.com/HQSquantumsimulations/qoqo_qasm"

diff --git a/qoqo_qasm/README.md b/qoqo_qasm/README.md
@@ -1,21 +1,10 @@
-<img src="../qoqo_Logo_vertical_color.png" alt="qoqo logo" width="300" />
-
 # qoqo-qasm
 
-Qasm interface for the qoqo/roqoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
-
-This repository contains two components:
-
-* The qoqo_qasm backend for the qoqo python interface to roqoqo
-* The roqoqo_qasm backend for roqoqo directly
-
-## qoqo-qasm
-
-[![Documentation Status](https://readthedocs.org/projects/qoqo-qasm/badge/?version=latest)](https://qoqo-qasm.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://img.shields.io/badge/docs-read-blue)](https://hqsquantumsimulations.github.io/qoqo_qasm/)
 [![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qasm/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qasm/actions)
 [![PyPI](https://img.shields.io/pypi/v/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
-![PyPI - License](https://img.shields.io/pypi/l/qoqo_qasm)
 [![PyPI - Format](https://img.shields.io/pypi/format/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
+![Crates.io](https://img.shields.io/crates/l/qoqo-qasm)
 
 Qasm interface for the qoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
 
@@ -25,23 +14,8 @@ Circuits containing operations without a corresponding expression can not be tra
 
 A source distribution now exists but requires a Rust install with a rust version > 1.47 and a maturin version { >= 0.14, <0.15 } in order to be built.
 
-## roqoqo-qasm
-
-[![Crates.io](https://img.shields.io/crates/v/roqoqo-qasm)](https://crates.io/crates/roqoqo-qasm)
-[![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qasm/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qasm/actions)
-[![docs.rs](https://img.shields.io/docsrs/roqoqo-qasm)](https://docs.rs/roqoqo-qasm/)
-![Crates.io](https://img.shields.io/crates/l/roqoqo-qasm)
-
-Qasm interface for the roqoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
-
-roqoqo-qasm provides the QasmBackend class that allows users translate a roqoqo circuit into a qasm file.
-Not all roqoqo operations have a corresponding qasm expression.  
-Circuits containing operations without a corresponding expression can not be translated.
-
 ## General Notes
 
-This software is still in the beta stage. Functions and documentation are not yet complete and breaking changes can occur.
-
 This project is partly supported by [PlanQK](https://planqk.de).
 
 ## Contributing

diff --git a/qoqo_qasm/pyproject.toml b/qoqo_qasm/pyproject.toml
@@ -8,6 +8,7 @@ dependencies = [
 license = {text="Apache-2.0 AND Apache-2.0 with LLVM-exception AND MIT AND Unicode-DFS-2016 AND BSD-2-Clause AND BSD-3-CLause"}
 maintainers = [{name = "HQS Quantum Simulations GmbH", email = "[email protected]"}]
 requires-python = ">=3.8"
+readme = "README.md"
 
 [project.optional-dependencies]
 docs = [

diff --git a/roqoqo-qasm/Cargo.toml b/roqoqo-qasm/Cargo.toml
@@ -3,7 +3,8 @@ name = "roqoqo-qasm"
 version = "0.9.3"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
-edition = "2018"
+edition = "2021"
+rust-version = "1.56"
 categories = ["science", "simulation"]
 readme = "README.md"
 repository = "https://github.com/HQSquantumsimulations/qoqo_qasm"

diff --git a/roqoqo-qasm/README.md b/roqoqo-qasm/README.md
@@ -1,31 +1,4 @@
-<img src="../qoqo_Logo_vertical_color.png" alt="qoqo logo" width="300" />
-
-# qoqo-qasm
-
-Qasm interface for the qoqo/roqoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
-
-This repository contains two components:
-
-* The qoqo_qasm backend for the qoqo python interface to roqoqo
-* The roqoqo_qasm backend for roqoqo directly
-
-## qoqo-qasm
-
-[![Documentation Status](https://readthedocs.org/projects/qoqo-qasm/badge/?version=latest)](https://qoqo-qasm.readthedocs.io/en/latest/?badge=latest)
-[![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qasm/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qasm/actions)
-[![PyPI](https://img.shields.io/pypi/v/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
-![PyPI - License](https://img.shields.io/pypi/l/qoqo_qasm)
-[![PyPI - Format](https://img.shields.io/pypi/format/qoqo_qasm)](https://pypi.org/project/qoqo_qasm/)
-
-Qasm interface for the qoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).
-
-qoqo-qasm provides the QasmBackend class that allows users translate a qoqo circuit into a qasm file.
-Not all qoqo operations have a corresponding qasm expression.  
-Circuits containing operations without a corresponding expression can not be translated.
-
-A source distribution now exists but requires a Rust install with a rust version > 1.47 and a maturin version { >= 0.14, <0.15 } in order to be built.
-
-## roqoqo-qasm
+# roqoqo-qasm
 
 [![Crates.io](https://img.shields.io/crates/v/roqoqo-qasm)](https://crates.io/crates/roqoqo-qasm)
 [![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qasm/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qasm/actions)
@@ -40,8 +13,6 @@ Circuits containing operations without a corresponding expression can not be tra
 
 ## General Notes
 
-This software is still in the beta stage. Functions and documentation are not yet complete and breaking changes can occur.
-
 This project is partly supported by [PlanQK](https://planqk.de).
 
 ## Contributing