User Story

As a user I would like to have all the information I need to understand how to use the framework

Summary / Background

Deppy is a framework for creating and configuring solvers. As a framework, it should be well documented with examples

Acceptance Criteria

• APIs documented
• How to build constraints and variables
• examples given

Nice to Have

• Architecture documented as needed

Assumptions

Links (docs, drawings, designs, etc)

[Deppy-as-a-Framework](https://hackmd.io/fDfcLKNzRPCgILMIQ8aPOw?view#Appendix-III-Deppy-as-a-Framework)

Dependencies

Definition of Done

• Readme with a quick start guide
• reviewed and merged

Upstream Github issue: https://github.com/operator-framework/deppy/issues/47