openpose/doc/advanced/library_structure/README.md

OpenPose C++ API - Introduction

As a user, you do not need to know anything about this section! This section is intended for OpenPose internal developpers. It is exposed publicly, but you can skip this whole folder if you are just trying to use OpenPose or create new code/demos using OpenPose.

Even if you want to e.g., change internal functions and/or extend the OpenPose functionality, the easiest solution as a user is to follow the examples/tutorial_api_cpp examples. If the new functionality is cool, make a pull request so we can add it to OpenPose!

In order to learn the basics about how OpenPose works internally:

1. Take a look at the library Quick Start section from the main README.
2. OpenPose Overview: Learn the basics about the library source code in doc/advanced/library_structure/library_overview.md.
3. Extending Functionality: Learn how to extend the library in doc/advanced/library_structure/library_extend_functionality.md.
4. Adding An Extra Module: Learn how to add an extra module in doc/advanced/library_structure/library_add_new_module.md.
5. See the Doxygen documentation on http://cmu-perceptual-computing-lab.github.io/openpose/html/index.html or build it from the source code.