diff --git a/README.md b/README.md index 380b7fabf..a988927ea 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,6 @@ This method won't work natively on Windows, however. Refer to the [installation -## Developer guide - -See the [developer guide](CONTRIBUTING.md) for instructions on contributing code to ffsim. - ## Citing ffsim @@ -45,3 +41,7 @@ You can cite ffsim using the following BibTeX: ``` + +## Developer guide + +See the [developer guide](CONTRIBUTING.md) for instructions on contributing code to ffsim. diff --git a/docs/index.md b/docs/index.md index eabd8c103..c47b60c37 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,27 +12,26 @@ :end-before: ``` +## Citing ffsim + +```{include} ../README.md +:start-after: +:end-before: +``` + ## Next steps We recommend starting with [State vectors and gates](explanations/state-vectors-and-gates.ipynb). Then, you can check out the following resources: - [Tutorials](tutorials/index.md) -- [How-to guides](how-to-guides/index.md) - [Explanations](explanations/index.md) +- [How-to guides](how-to-guides/index.md) +- [API Reference](api/index.md) -## Developer guide - -See the [developer guide](https://github.com/qiskit-community/ffsim/blob/main/CONTRIBUTING.md) hosted on GitHub for instructions on contributing code to ffsim. - -## Citing ffsim - -```{include} ../README.md -:start-after: -:end-before: -``` +## Contents ```{toctree} -:hidden: +:maxdepth: 2 install tutorials/index