Skip to content

Commit

Permalink
Updated features
Browse files Browse the repository at this point in the history
  • Loading branch information
nkoenig committed Jul 19, 2018
1 parent 83f33dd commit 1310425
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
17 changes: 14 additions & 3 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,20 @@ ign_create_packages()
# Configure documentation
#============================================================================
set (IGN_PROJECT_ABOUT
"Ignition Math is a component in the Ignition framework, a set of libraries
designed to rapidly develop robot applications. The library defines math
classes and functions used in other Ignition libraries and programs.")
"Ignition Math is a component in Ignition Robotics, a set of libraries
designed to rapidly develop robot and simulation applications.
This library defines a general set of math classes and functions with an
eye toward simulation and robotics.
## Features
1. Templated data types including multi-dimensional vectors, and rotational and position data types.
2. Geometric shapes such as boxes, cylinders, spheres, and planes.
3. A generic graph class with supporting algorithms including breadth and depth first sorting, and Dijkstra.
4. Convenience classes such as Color, KMeans, PID, StopWatch, Spline, and Temperature.
5. Helper functions that can clamp values, check for equality between floating point values, and more.
")

configure_file(${CMAKE_SOURCE_DIR}/api.md.in ${CMAKE_BINARY_DIR}/api.md)
configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials.md)

Expand Down
5 changes: 0 additions & 5 deletions api.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

@IGN_PROJECT_ABOUT@

**Useful links**

* [Tutorials](https://ignitionrobotics.org/tutorials/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/index.html)
* [Code Repository](https://bitbucket.org/ignitionrobotics/ign-@IGN_DESIGNATION@)

## License

The code associated with this documentation is licensed under an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
Expand Down

0 comments on commit 1310425

Please sign in to comment.