OVMS3-idf/examples/build_system/cmake/import_lib/README.md

# Import Third-Party CMake Library Example

This example demonstrates how to import third-party CMake libraries.

## Example Flow

[tinyxml2](https://github.com/leethomason/tinyxml2) is a 
a small C++ XML parser. It is imported, without modification, for use in the project's `main` component (see the `main` component's [CMakeLists.txt](main/CMakeLists.txt)). To demonstrate the library being used, a sample XML is embedded into the project.
This sample XML is then read and parsed later on using `tinyxml2`.

### Output

```
I (317) example: Setting up...
I (317) example: Copying sample XML to filesystem...
I (647) example: Reading XML file
I (657) example: Read XML data:
<?xml version="1.0" encoding="UTF-8"?>
<note>
    <to>Tove</to>
    <from>Jani</from>
    <heading>Reminder</heading>
    <body>Don't forget me this weekend!</body>
</note>

I (667) example: Parsed XML data:

To: Tove
From: Jani
Heading: Reminder
Body: Don't forget me this weekend!
I (677) example: Example end
```
---

There is a discussion on importing third-party CMake libraries in the programming guide under `API Guides` -> `Build System` -> `Using Third-Party CMake Projects with Components`
examples: generic cmake support examples 2018-11-11 07:36:24 +00:00			`# Import Third-Party CMake Library Example`

			`This example demonstrates how to import third-party CMake libraries.`

			`## Example Flow`

			`[tinyxml2](https://github.com/leethomason/tinyxml2) is a`
			a small C++ XML parser. It is imported, without modification, for use in the project's `main` component (see the `main` component's [CMakeLists.txt](main/CMakeLists.txt)). To demonstrate the library being used, a sample XML is embedded into the project.
			This sample XML is then read and parsed later on using `tinyxml2`.

			`### Output`

			```
			`I (317) example: Setting up...`
			`I (317) example: Copying sample XML to filesystem...`
			`I (647) example: Reading XML file`
			`I (657) example: Read XML data:`
			`<?xml version="1.0" encoding="UTF-8"?>`
			`<note>`
			`<to>Tove</to>`
			`<from>Jani</from>`
			`<heading>Reminder</heading>`
			`<body>Don't forget me this weekend!</body>`
			`</note>`

			`I (667) example: Parsed XML data:`

			`To: Tove`
			`From: Jani`
			`Heading: Reminder`
			`Body: Don't forget me this weekend!`
			`I (677) example: Example end`
			```
			`---`

docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-25 01:26:53 +00:00			There is a discussion on importing third-party CMake libraries in the programming guide under `API Guides` -> `Build System` -> `Using Third-Party CMake Projects with Components`