Skip to content

Commit

Permalink
Update README after the first release (#77)
Browse files Browse the repository at this point in the history
Now that the 0.0.1 release has been tagged and published on crates.io
this commit updates the README to reflect this a bit better. It adds
some basic tags to the README around the version on crates.io and the
MSRV and removes a section talking about a potential first release.
  • Loading branch information
mtreinish committed Jan 26, 2024
1 parent 4d1bcb5 commit 9678194
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# OpenQASM 3 Parser
[![License](https://img.shields.io/github/license/Qiskit/rustworkx.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
[![Minimum rustc 1.70](https://img.shields.io/badge/rustc-1.70+-blue.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html)
[![oq3_semantics crate](https://img.shields.io/crates/v/oq3_semantics.svg)](https://crates.io/crates/oq3_semantics)


This project provides a compiler front end for OpenQASM 3 language (OQ3).

Expand All @@ -10,20 +14,6 @@ Differences with the [OpenQASM reference parser](https://github.com/openqasm/ope
A crude test with large source files showed parse time reduced by a factor of 80.
* `openqasm3_parser` performs semantic analysis.

<details>
<summary>What is a rust "crate"</summary>

We talk about rust ["crates"](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html).
A rust library crate is more or less the source for a rust library that is developed, built, and installed with the rust package manager [cargo](https://doc.rust-lang.org/cargo/).
This single repository contains more than one separately installable crates. In the future, this repository may also be used to generate other artifacts.

</details>

### Status

There have been no releases of any kind. I'll try to keep something more or less meaningful in this spot.
For instance, I hope to soon replace "I" with "we".

### Crates (roughly one installable library per crate)

The first three crates are based on tools for `rust` and `rust-analyzer`.
Expand All @@ -41,6 +31,16 @@ There are other names for this structure. But "ASG" is convenient.
* [oq3_source_file](./crates/oq3_source_file) -- A higher-level interface to the syntactic AST. This sits beetween the syntactic AST and
semantic ASG. This crate manages the main source file and incuded source files.

<details>
<summary>What is a rust "crate"</summary>

We talk about rust ["crates"](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html).
A rust library crate is more or less the source for a rust library that is developed, built, and installed with the rust package manager [cargo](https://doc.rust-lang.org/cargo/).
This single repository contains more than one separately installable crates. In the future, this repository may also be used to generate other artifacts.

</details>


### Warning !

Do not run `cargo test`. Rather use `./run_tests.sh` or commands found therein. This is because codegen is implemented via
Expand Down

0 comments on commit 9678194

Please sign in to comment.