Skip to content

Re-write the user guide

Tiago de Freitas Pereira requested to merge 22-documentation-of-this-package-sucks into master

The major change here was the user guide section; it was completely rewritten. I tried to:

  • Write about every algorithm that we have
  • Provide some intuitions on how the stuff works
  • Provide a copy and paste code snipped.

I'm working these issues #22 (closed), #21 (closed) and #20 (closed) with this PR.

Merge request reports