Update README with SAOR description.

artofscience / SAOR

Sequential Approximate Optimization Repository

GNU General Public License v3.0

5 stars 1 forks source link

Update README with SAOR description. #103

Closed MaxvdKolk closed 2 years ago

MaxvdKolk commented 2 years ago

This adds a brief introduction and usage example to make our current README a bit more descriptive. Once the package and docs is hosted elsewhere, we can update the remaining sections.

Some questions:

What do you think of the linked PDFs and do you have a suggestion for OC?
Should we refer directly to PDFs or prefer to link through DOIs?
The current examples might be a bit too concise? We can add some more context, just wondering about what problem to use as an example (Square?)

MaxvdKolk commented 2 years ago

The PR is ready, I think, if we agree on just hyperlinking the DOI in combination with author year for the purposes of the README. I'll let it up to you, @artofscience, to merge :+1: