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

| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-S2 | ESP32-S3 |
| ----------------- | ----- | -------- | -------- | -------- | -------- |

# 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 small C++ XML parser.

It is imported, without modification, into the [tinyxml2](components/tinyxml2/) component. Please refer to the component CMakeLists.txt file for the description of the process: [components/tinyxml2/CMakeLists.txt](components/tinyxml2/CMakeLists.txt).

To demonstrate the library being used, a sample XML is embedded into the project. This sample XML is then read and parsed using `tinyxml2`. Please refer to the [main](main/) component for details.

### 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`
docs: changes docs supported targets tables 2022-07-12 22:41:36 -04:00			`\| Supported Targets \| ESP32 \| ESP32-C2 \| ESP32-C3 \| ESP32-S2 \| ESP32-S3 \|`
			`\| ----------------- \| ----- \| -------- \| -------- \| -------- \| -------- \|`

examples: generic cmake support examples 2018-11-11 02:36:24 -05:00			`# Import Third-Party CMake Library Example`

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

			`## Example Flow`

examples: import_lib: demonstrate ExternalProject_Add Many of the more complicated CMake projects can't be added to the IDF build system simply by calling add_subdirectory. "add_subdirectory" also cannot be used with projects which use build systems other than CMake (for example GNU Make or cargo). This commit changes the example to use ExternalProject_Add, instead, which is a more general way of adding subprojects. As part of this change, tinyxml2 is now downloaded from the Internet, which allows removing one submodule. 2022-06-29 14:14:37 -04:00			`[tinyxml2](https://github.com/leethomason/tinyxml2) is a small C++ XML parser.`

			`It is imported, without modification, into the [tinyxml2](components/tinyxml2/) component. Please refer to the component CMakeLists.txt file for the description of the process: [components/tinyxml2/CMakeLists.txt](components/tinyxml2/CMakeLists.txt).`

			To demonstrate the library being used, a sample XML is embedded into the project. This sample XML is then read and parsed using `tinyxml2`. Please refer to the [main](main/) component for details.
examples: generic cmake support examples 2018-11-11 02:36:24 -05:00
			`### 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-24 21:26:53 -04: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`