1# sdformat #
2
3SDF is an XML file format that describes environments, objects, and robots
4in a manner suitable for robotic applications. SDF is capable of representing
5and describing different physic engines, lighting properties, terrain, static
6or dynamic objects, and articulated robots with various sensors, and acutators.
7The format of SDF is also described by XML, which facilitates updates and
8allows conversion from previous versions. A parser is also contained within
9this package that reads SDF files and returns a C++ interface.
10
11Test coverage:
12
13[![codecov](https://codecov.io/bb/osrf/sdformat/branch/default/graph/badge.svg)](https://codecov.io/bb/osrf/sdformat)
14
15
16## Installation ##
17
18Standard installation can be performed in UNIX systems using the following
19steps:
20
21 - mkdir build/
22 - cd build/
23 - cmake ..
24 - sudo make install
25
26sdformat supported cmake parameters at configuring time:
27 - USE_INTERNAL_URDF (bool) [default False]
28   Use an internal copy of urdfdom 1.0.0 instead of look for one
29   installed in the system
30 - USE_UPSTREAM_CFLAGS (bool) [default True]
31   Use the sdformat team compilation flags instead of the common set defined
32   by cmake.
33
34## Uninstallation ##
35
36To uninstall the software installed with the previous steps:
37 - cd build/
38 - sudo make uninstall
39