Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Update README.md #5

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WIP Update README.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f17e32
Update README.md
garrison Jan 10, 2022
4dd6b8b
Merge branch 'main' into wip-readme
garrison Jan 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 14 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 - [email protected]
* Caleb Johnson - [email protected]

## References and Acknowledgements

[1] Diátaxis Technical Documentation Framework \
https://diataxis.fr/

Expand Down