Document the difference between solvers

stack-of-tasks / eiquadprog

C++ reimplementation of eiquadprog

GNU Lesser General Public License v3.0

34 stars 25 forks source link

Document the difference between solvers #3

Closed nim65s closed 4 years ago

nim65s commented 4 years ago

As reported by @jmirabel in https://github.com/humanoid-path-planner/hpp-core/issues/190#issuecomment-574752995, it would be nice to explain why do we have

eiquadprog
eiquadprog-fast
eiquadprog-rt

This should probably go to the README.

@gabrielebndn: could you do that ? :)

gabrielebndn commented 4 years ago

It can be easily explained in a few lines. I think the best would be a properly-made doc, with doxygen and all, but it would take me some time to set it up. If I can just put them in the README, I can certainly do it very quickly.

nim65s commented 4 years ago

A couple lines in the README would do for now, because it currently says that

This repo contains a C++ implementation

While it contains 3…

I don't mind a properly-made doc, but we don't have to wait for it to fix the README :)

jmirabel commented 4 years ago

A doxygen doc is overkill for this purpose.

nim65s commented 4 years ago

fixed by #5