Go to file
Kyle Isom 52ba9d8ebe Add sphinx as doc target. 2019-08-08 03:51:22 +00:00
cmake Add sphinx as doc target. 2019-08-08 03:51:22 +00:00
docs Add sphinx as doc target. 2019-08-08 03:51:22 +00:00
extern Major updates, start orientation, start documentation. 2019-08-03 03:37:37 -07:00
include/wrmath Add Euler angles to Madgwick and update docs. 2019-08-07 19:17:58 +00:00
src Updating docs. 2019-08-06 23:05:51 -07:00
test Add Euler angles to Madgwick and update docs. 2019-08-07 19:17:58 +00:00
tools Start Madwick filters. 2019-08-06 22:49:20 -07:00
.gitignore Update sphinx docs; use exhale and breathe. 2019-08-07 01:57:26 +00:00
.gitmodules Major updates, start orientation, start documentation. 2019-08-03 03:37:37 -07:00
CMakeLists.txt Add sphinx as doc target. 2019-08-08 03:51:22 +00:00
CMakePack.txt Add sphinx as doc target. 2019-08-08 03:51:22 +00:00
LICENSE.txt Initial import. 2019-08-03 02:03:44 +00:00
README.rst Add a README. 2019-08-06 10:41:26 -07:00
update-docs Add Euler angles to Madgwick and update docs. 2019-08-07 19:17:58 +00:00

README.rst

wrmath
======

The WNTRMUTE ROBOTICS maths library is a C++11 library containing various
useful maths components for robotics and navigation.

Dependencies
------------

This project uses Google Test as a dependency::

  $ git submodule update --init --recursive

Additionally, building this requires

+ a C++11 compiler
+ CMake (minimum 3.15 to support code coverage, otherwise 3.10).
+ Doxygen


Building
--------

.. code::

    mkdir build
    cmake ..
    make check