Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Crate name as README title + add reexport #199

Merged
merged 2 commits into from
Jun 22, 2023
Merged

doc: Crate name as README title + add reexport #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b91d99
doc: Crate name as README title
aborgna-q Jun 22, 2023
32ace5c
Add usage section for package vs crate name
aborgna-q Jun 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
hugr
====
quantinuum-hugr
===============

[![build_status][]](https://github.com/CQCL/hugr/actions)
[![msrv][]](https://github.com/CQCL/hugr)
Expand All @@ -17,6 +17,17 @@ The HUGR specification (still in draft) is [here](specification/hugr.md).

- `pyo3`: Enable Python bindings via pyo3.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
quantinuum-hugr = "0.1"
```

The library crate is called `hugr`.

## License

This project is licensed under Apache License, Version 2.0 ([LICENSE][] or http://www.apache.org/licenses/LICENSE-2.0).
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ pub mod types;
mod utils;

pub use crate::hugr::{
Direction, Hugr, Node, Port, Replace, ReplaceError, SimpleReplacement, Wire,
Direction, Hugr, HugrView, Node, Port, Replace, ReplaceError, SimpleReplacement, Wire,
};
pub use crate::resource::Resource;