From 55bec9a9ef8f9f87b35a741e21795dcc1ca42184 Mon Sep 17 00:00:00 2001 From: John Lapeyre Date: Tue, 26 Mar 2024 15:01:07 -0400 Subject: [PATCH] Update README.md Add a paragraph on motivation for the existence of this repo. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e92b706..fc5d832 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,19 @@ This project provides a compiler front end for OpenQASM 3 language (OQ3). In this document, this parser is referred to as `openqasm3_parser`. -Differences with the [OpenQASM reference parser](https://github.com/openqasm/openqasm) are +### Why is this important? + +There is a lot of interest in using OpenQASM 3 for a number of purposes. For example, for controlling +hardware and as an exchange medium for quantum circuits. This project aims to provide a performant, +robust front end to compilers and importers. There are no other open source (or public) projects of this +kind. + +Differences with the [OpenQASM reference parser](https://github.com/openqasm/openqasm) include * The parser in `openqasm3_parser` is much more performant. A crude test with large source files showed parse time reduced by a factor of 80. -* `openqasm3_parser` performs semantic analysis. +* `openqasm3_parser` performs semantic analysis. In particular diagnostics and error reporting + are much better. ### Contributing