address review

CQCL · Jun 3, 2024 · f168d8e · f168d8e
1 parent b3876ab
commit f168d8e
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/release-plz.toml b/release-plz.toml
@@ -31,3 +31,12 @@ commit_parsers = [
 [[package]]
 name = "tket2"
 release = true
+
+[[package]]
+name = "tket2-hseries"
+release = true
+
+# Disabled until the first version is manually published
+publish = false
+git_tag_enable = false
+git_release_enable = false
diff --git a/tket2-hseries/CHANGELOG.md b/tket2-hseries/CHANGELOG.md
diff --git a/tket2-hseries/Cargo.toml b/tket2-hseries/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tket2-hseries"
-version = "0.1.0"
+version = "0.1.0-alpha.1"
 edition.workspace = true
 rust-version.workspace = true
 
@@ -21,7 +21,7 @@ cli = ["dep:hugr-cli", "dep:clap"]
 hugr.workspace = true
 hugr-cli = { workspace = true, optional = true }
 clap = { workspace = true, optional = true, features = ["derive"] }
-tket2.workspace = true
+tket2 = { path = "../tket2", version = "0.1.0-alpha.1" }
 serde_json.workspace = true
 lazy_static.workspace = true
 

diff --git a/tket2-hseries/README.md b/tket2-hseries/README.md
@@ -1,4 +1,35 @@
 # tket2-hseries
 
+![msrv][]
+[![codecov][]](https://codecov.io/gh/CQCL/tket2/tket2-hseries)
+
 A TKET2 tool for preparing and validating `Hugr`s for compilation targeting
 Quantinuum H-series  quantum computers.
+
+## Usage
+
+Install using `cargo`:
+
+```bash
+cargo install tket2-hseries
+```
+
+This will install the `tket2-hseries` binary. 
+
+## Recent Changes
+
+See [CHANGELOG][] for a list of changes. The minimum supported rust
+version will only change on major releases.
+
+## Development
+
+See [DEVELOPMENT.md][] for instructions on setting up the development environment.
+
+## License
+
+This project is licensed under Apache License, Version 2.0 ([LICENSE][] or http://www.apache.org/licenses/LICENSE-2.0).
+
+  [msrv]: https://img.shields.io/badge/rust-1.75.0%2B-blue.svg
+  [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2/tket2-hseries?logo=codecov
+  [LICENSE]: https://github.com/CQCL/tket2/blob/main/LICENCE
+  [CHANGELOG]: https://github.com/CQCL/tket2/blob/main/tket2-hseries/CHANGELOG.mdd
diff --git a/tket2-py/Cargo.toml b/tket2-py/Cargo.toml
@@ -19,7 +19,7 @@ test = false
 bench = false
 
 [dependencies]
-tket2 = { workspace = true, features = ["portmatching"] }
+tket2 = { path = "../tket2", version = "0.1.0-alpha.1" }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 tket-json-rs = { workspace = true, features = ["pyo3"] }

diff --git a/tket2/README.md b/tket2/README.md
@@ -2,7 +2,7 @@
 
 [![build_status][]](https://github.com/CQCL/tket2/actions)
 ![msrv][]
-[![codecov][]](https://codecov.io/gh/CQCL/tket2)
+[![codecov][]](https://codecov.io/gh/CQCL/tket2/tket2)
 
 TKET2 is an open source quantum compiler developed by Quantinuum. Central to
 TKET2's design is its hardware agnosticism which allows researchers and
@@ -69,7 +69,7 @@ This project is licensed under Apache License, Version 2.0 ([LICENSE][] or http:
 
   [build_status]: https://github.com/CQCL/tket2/workflows/Continuous%20integration/badge.svg?branch=main
   [msrv]: https://img.shields.io/badge/rust-1.75.0%2B-blue.svg
-  [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2?logo=codecov
+  [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2/tket2?logo=codecov
   [hugr]: https://lib.rs/crates/hugr
   [hugr Builder]: https://docs.rs/hugr/latest/hugr/builder/index.html
   [API documentation here]: https://docs.rs/tket2/