Skip to content

Commit 2b41746

Browse files
committed
Add citation instructions to README
1 parent 5b11c69 commit 2b41746

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,16 @@ for int shot_index in [0:99] {
147147

148148
We welcome contributions to OQpy including bug fixes, feature requests, etc. To get started, check
149149
out our [contributing guidelines](CONTRIBUTING.md).
150+
151+
## Citation
152+
153+
If you use OQpy in your work or research, please cite it using the metadata in the
154+
[`CITATION.cff`][citation-file] file in the repository (which includes a
155+
[Zenodo DOI][zenodo-doi]). You can copy the citation in BibTeX format using the
156+
["Cite this repository" widget][citation-widget] in the About section of the
157+
[repository page on GitHub][github].
158+
159+
[zenodo-doi]: https://doi.org/10.5281/zenodo.7349265
160+
[citation-file]: https://github.com/openqasm/oqpy/blob/main/CITATION.cff
161+
[citation-widget]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
162+
[github]: https://github.com/openqasm/oqpy

0 commit comments

Comments
 (0)