Add a README.
This commit is contained in:
@@ -1,4 +1,8 @@
|
||||
if (DEFINED ENV{CMAKE_GCOV})
|
||||
cmake_minimum_required(VERSION 3.15)
|
||||
else()
|
||||
cmake_minimum_required(VERSION 3.10)
|
||||
endif()
|
||||
cmake_policy(SET CMP0048 NEW)
|
||||
|
||||
|
||||
|
||||
28
README.rst
Normal file
28
README.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
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
|
||||
Reference in New Issue
Block a user