Update README with instructions for building and running unit tests
This commit is contained in:
parent
08da39e16e
commit
8b019092f6
1 changed files with 18 additions and 0 deletions
18
README.md
18
README.md
|
@ -18,6 +18,18 @@ C++ library for interfacing with iRobot's [Create 1 and 2](http://www.irobot.com
|
|||
|
||||
* [Boost System Library](http://www.boost.org/doc/libs/1_59_0/libs/system/doc/index.html)
|
||||
* [Boost Thread Library](http://www.boost.org/doc/libs/1_59_0/doc/html/thread.html)
|
||||
* [Optional] [googletest](https://github.com/google/googletest)
|
||||
|
||||
### Install ###
|
||||
|
||||
sudo apt-get install build-essential cmake libboost-system-dev libboost-thread-dev
|
||||
|
||||
# Optionally, install gtest for building unit tests
|
||||
sudo apt-get install libgtest-dev
|
||||
cd /usr/src/gtest
|
||||
sudo cmake CMakeLists.txt
|
||||
sudo make
|
||||
sudo cp *.a /usr/lib
|
||||
|
||||
#### Serial Permissions ####
|
||||
|
||||
|
@ -48,6 +60,12 @@ Note, the examples found in the "examples" directory are built with the library.
|
|||
git clone https://github.com/AutonomyLab/libcreate.git
|
||||
catkin build
|
||||
|
||||
## Running Tests ##
|
||||
|
||||
To run unit tests, execute the following in the build directory:
|
||||
|
||||
make test
|
||||
|
||||
## Known Issues ##
|
||||
|
||||
* _Clock_ and _Schedule_ buttons are not functional. This is a known bug related to the firmware.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue