Write Docs

[pedromxavier]

There are a few comments in #59 about documentation. I'm listing them and other topics here as tasks for another PR yet to be opened.

Manual

• Tell how to run a model
• How to gather results
• How to adjust compiler settings

Booklet

• Organize the booklet and the manual into separate files.
• Quadratization
  • Better explain what stable quadratizations are¹
  • Finish the primer on submodularity
• Variable Encoding
  • Make the explanation uniform across different methods
  • Describe the methodology for the computation of the number of bits given an error tolerance²

Examples

• "Mention how exciting is solving a problem with a quantum annealer maybe³"
• Give more context for the prime factoring example⁴

Footnotes

1. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1096178231 ↩

2. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1103288064 ↩

3. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095202165 ↩

4. @joaquimg, @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095355993 ↩