cyang-kth / fmm

Fast map matching, an open source framework in C++
https://fmm-wiki.github.io/
Apache License 2.0
884 stars 211 forks source link

C++ API Documentation #153

Closed brunoeducsantos closed 3 years ago

brunoeducsantos commented 3 years ago

Hi @cyang-kth,

Thanks for the awesome project.

I wonder if there is any documentation about C++ API usage. From the installation is generated sharable object, but I can't access the libraries.

Thanks.

Regards,

Bruno

cyang-kth commented 3 years ago

You may refer to this link for using fmm in an external project with cmake (please pull the latest version which will install headers of fmm).

https://github.com/cyang-kth/fmm/tree/master/example/cpp-api

The above link is not tested and it may still have issues under different platforms.

The C++ API could be found at https://cyang-kth.github.io/fmm/

cyang-kth commented 3 years ago

Another way could be placing your source code under src the same folder and modify the cmakelists.txt file like the following lines.

Just add one extra line with your cpp file and link it with the FMMLIB library.

https://github.com/cyang-kth/fmm/blob/cdcda9a9ba4fc103ed217f73fbd7acce176f1ee1/CMakeLists.txt#L134-L147

brunoeducsantos commented 3 years ago

Thanks a lot @cyang-kth for your quick help. I rather use as an external library to be more modular. Thanks again.