Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Improve Documentation for Red Queen #42

Open
Lementknight opened this issue Aug 13, 2022 · 1 comment
Open

Improve Documentation for Red Queen #42

Lementknight opened this issue Aug 13, 2022 · 1 comment

Comments

@Lementknight
Copy link
Contributor

Lementknight commented Aug 13, 2022

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

@shraddha-aangiras
Copy link

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants