README

[kmactavish]

Write a top-level README that explains high-level use of lgmath.

[cglwn]

Here's an outline:

• This library is aimed towards kinematics and geometry problems.
• Uses Eigen as its back-end
• Requires c++11 (this will make packaging easier, let's pull the trigger on this)
• Example of how to use it as a standalone third party library. Will do as part of Add examples for how to use lgmath #25
• Doxygen return / args for each function (Not part of the README, created Document function parameters and return values #22)
• A reference to the definition in Tim's textbook for each applicable function. (Not part of the README, created Document function parameters and return values #22 )

I moved the low priority stuff which aren't open-source blockers to

Let me know what you think. I will edit this comment as we go.

[sanderson77]

Jim!

[cglwn]

Doctor Anderson! Get back to work doing ̹̤͈͈̱̝̲̺ͪ̒̈́͒̏̿̑̄̏͘͢͝t͕͙̙̘̼̅̽ͪ̃͊ͯ̐͐́ͅh̶̖͉͉̰̬̖̪̞̰͍̫̞͖̤̣̩͇̱̐ͩ̇ͨ̔ͪ̾̃̐ͩ̈́̊̊̿͆̍̔̕a̱͍̦͇̰̫̭͚̖͍͍̙͍̒̒̀̊͘͜͝͡ͅt̶̰̭̘̹ͩ̒̒ͪ̾͑ͪ̈̌͌̓͐̈ͫ͂ͬ̾̏͢͜ ̴̷̨̊̍̋̏͏̢͔̝̘̦̞̮̤̼̠̙̳t̢̛̳̖̭̿ͥͧ̒̌̇̑͆̈ͬͭ̇ͧ̇̎̈ͯ̓ͮ̕͟͝o͉̹͖̪̻̯͙̞̯̅ͫ̐̋̏̕͢͜p̢̛̤̠̻̣̼̫̦̪͕̠ͦ̃ͫͭͅͅ ̶̡̮͖̤̝̦̰͙̹̘̻̬̳ͪͯ͛̏͗́͌̇ͩ͑ͪ́͆̓͊̈́ͬ̚͞ͅs̨͇̦̲͓̳̙ͭ͂̐́̕͘͡͠e̷̞̘̹̘̝̱̗̩͖̞̲̩ͨ͒́̈́͂ͪͤ̅́͟͠c̡̡̲̳̪̜͙̟̱̟̰̼̙̖͈͉̩̤ͥͬ͛̉ͣ̋̊̀̕͟ŗ̠̯͖̮̗͎͓̥̩͈̻͍̟͙ͣ̽ͪ͗̈́́̅͋́ͬͬͧͨ̀̚͘͢͝ę̸̧̖͍̘͔̭̺̭̭̮̯͈̹̺̺̑ͥ̒ͨ̑͗ͣͭ̀͘ͅͅt͍̞̳̱ͦ̇ͧ̽͛̊̏̀̕ ̸̨͖̝͇̼͈̦͈̱̲̥̟̘͕̗͈̖̝̓̒͌ͯͨ́͑ͥ̾ͬ̇͊̐ͮ̆̚͘s̓̉ͭͪ̽̓̍͂̓̈̃͋͐ͨ̍̏̾͏̛̯̜̝̜̬͖̖̯̞̥̝̺̬̜̳̠̠̼͘ț̢͔͙̫̬̣̥̜̘ͪͫͥ̀ͨͬͥ̒ͩ͐̍͊ͮ̀͘͡͡ͅuͫ́͌̈́̂̂̃̀ͭ͋ͩ͞҉͔̫͈̳̙̕ͅf̵̵̸̼͇̩̱̙̫̖ͤͦ̉̐ͪ̍̉̈ͮ̿͌̓ͦͨ͆ͪ̌̀f̦̟̣̗͕̣̰̟̖̮͖͇̻̲͔̾͒̄̈́͗̽̃̉̐̀̋ͥ̍͂ͣͣͩ͟͞ͅ.̭̦̗̫͉̼ͧͮ͌ͭ̿ͨͮ͜.

[kmactavish]

Ah, a spy! 🔍

[cglwn]

Made a PR for it in #28