Add a README.

This commit is contained in:
Kyle Isom 2019-08-06 10:41:26 -07:00
parent b7c42a5fc5
commit eaed085fdb
2 changed files with 33 additions and 1 deletions

View File

@ -1,4 +1,8 @@
if (DEFINED ENV{CMAKE_GCOV})
cmake_minimum_required(VERSION 3.15) cmake_minimum_required(VERSION 3.15)
else()
cmake_minimum_required(VERSION 3.10)
endif()
cmake_policy(SET CMP0048 NEW) cmake_policy(SET CMP0048 NEW)
@ -12,7 +16,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
# functions might be used. # functions might be used.
add_compile_options(-Werror -Wno-unused-function -Wall -g -O0) add_compile_options(-Werror -Wno-unused-function -Wall -g -O0)
if(DEFINED ENV{CMAKE_GCOV}) if (DEFINED ENV{CMAKE_GCOV})
add_compile_options(-fprofile-arcs -ftest-coverage) add_compile_options(-fprofile-arcs -ftest-coverage)
# Need CMake 3.15+. # Need CMake 3.15+.
add_link_options(-fprofile-arcs -ftest-coverage) add_link_options(-fprofile-arcs -ftest-coverage)

28
README.rst Normal file
View 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