diff --git a/README.md b/README.md index 1e0c588..6a1dab9 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,29 @@ # Quantum Prototype Template -### Table of Contents +## Table of Contents -##### For Users +### For Users -1. [About the Project](docs/project_overview.md) -2. [Beginner's Guide](docs/beginners_guide.md) -3. [Installation](docs/installation_guide.md) -4. [Quickstart Guide](docs/quickstart_guide.md) -5. [Tutorials](docs/tutorials/example_tutorial.ipynb) -6. [How-Tos](docs/how_tos/example_how_to.ipynb) -7. [Prototype Template File Glossary](docs/file-map-and-description.md) -8. [How to Give Feedback](#how-to-give-feedback) -9. [Contribution Guidelines](#contribution-guidelines) -10. [References and Acknowledgements](#references-and-acknowledgements) -11. [License](#license) +1. [About the Project](docs/project_overview.md) +2. [Beginner's Guide](docs/beginners_guide.md) +3. [Installation](docs/installation_guide.md) +4. [Quickstart Guide](docs/quickstart_guide.md) +5. [Tutorials](docs/tutorials/example_tutorial.ipynb) +6. [How-Tos](docs/how_tos/example_how_to.ipynb) +7. [Prototype File Glossary](docs/file-map-and-description.md) -##### For Developers/Contributors +### For Developers/Contributors 1. [Contribution Guide](CONTRIBUTING.md) 2. [Technical Docs](docs/technical_docs.md) +## Contact ----------------------------------------------------------------------------------------------------- - -### How to Give Feedback - -We encourage your feedback! You can share your thoughts with us by: -- [Opening an issue](https://github.com/IBM-Quantum-Prototypes/quantum-prototype-template/issues) in the repository - - ----------------------------------------------------------------------------------------------------- - -### Contribution Guidelines - -For information on how to contribute to this project, please take a look at our [contribution guidelines](CONTRIBUTING.md). - - ----------------------------------------------------------------------------------------------------- +* Iskandar Sitdikov - iskandar.sitdikov@ibm.com +* Caleb Johnson - caleb.johnson@ibm.com ## References and Acknowledgements + [1] Diátaxis Technical Documentation Framework \ https://diataxis.fr/