red-queen icon indicating copy to clipboard operation
red-queen copied to clipboard

Improve Documentation for Red Queen

Open Lementknight opened this issue 3 years ago • 1 comments

Red Queen has many nuances that should be properly documented so that fellow open sources developers have an easier time both developing for Red Queen and using it.

-Add documentation to explain how to add new benchmarks

-Add guidance on how to use virtual environments in the README.md

-Update README.md to reflect its transition to a python package [#27 Addresses This]

-Add Docstrings to files

-Add description of quantum circuit each benchmark uses

Lementknight avatar Aug 13 '22 04:08 Lementknight

As a part of QAMP Fall '22 I'd like to work on this issue @mtreinish

shraddha-aangiras avatar Dec 06 '22 00:12 shraddha-aangiras