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.

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: Update readme #121

Merged
merged 4 commits into from
Jan 19, 2024
Merged

doc: Update readme #121

merged 4 commits into from
Jan 19, 2024

Conversation

mark-koch
Copy link
Collaborator

@mark-koch mark-koch commented Jan 19, 2024

Closes #120

@mark-koch mark-koch force-pushed the doc/readme branch 2 times, most recently from 2c2433a to f12c88b Compare January 19, 2024 14:04
@mark-koch mark-koch requested a review from ss2165 January 19, 2024 14:05
README.md Outdated
It allows you to write high-level hybrid quantum programs with classical control flow and mid-circuit measurements using Pythonic syntax:

```python
from guppylang import guppy
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strictly speaking, we also need to import Qubit or do from __future__ import annotations.

Do we want to add that here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add import Qubit

README.md Outdated
It allows you to write high-level hybrid quantum programs with classical control flow and mid-circuit measurements using Pythonic syntax:

```python
from guppylang import guppy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add import Qubit

README.md Outdated
```

which will create a directory `./guppy-exports` populated with hugr modules serialised in msgpack.

## Packaging
### Packaging
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think get rid of packaging, if we're on pypi there should only be one place to call this (on a release actions workflow ideally)

@mark-koch mark-koch requested a review from ss2165 January 19, 2024 14:37
@mark-koch mark-koch merged commit bd4ff8b into main Jan 19, 2024
1 check passed
@mark-koch mark-koch deleted the doc/readme branch January 19, 2024 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document build/test workflow in readme
2 participants