Merge pull request #18 from ament/gtest_docs

adding basic usage to description
ament · Aug 7, 2015 · 4f58214 · 4f58214
2 parents 21cfa94 + d9e5c17
commit 4f58214
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/ament_cmake_gtest/doc/usage.md b/ament_cmake_gtest/doc/usage.md
@@ -0,0 +1,8 @@
+
+## Usage
+
+To use this package do the following things.
+ - add a test dependency to your packages.xml: `<test_depend>ament_cmake_gtest</test_depend>`
+ - Write a gtest executable: Use `#include <gtest/gtest.h>` and standard gtest methods.
+ - Find package gtest in your CMakeLists.txt: `find_package(ament_cmake_gtest REQUIRED)`
+ - Add a cmake target using the `ament_add_gtest` cmake macro