docs: Add C/C++ include paths use examples

ravenexp · Feb 15, 2024 · 81b3324 · 81b3324
1 parent e07fcfa
commit 81b3324
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,3 +69,20 @@ fn main() {
         .emit();
 }
 ```
+
+## Getting C/C++ include paths from Conan dependencies
+
+To use the list of include paths, do the following after
+parsing the `conan install` output:
+
+```rust
+use conan2::ConanInstall;
+
+let metadata = ConanInstall::new().run().parse();
+
+for path in metadata.include_paths() {
+    // Add "-I{path}" to CXXFLAGS or something.
+}
+
+metadata.emit();
+```
diff --git a/src/lib.rs b/src/lib.rs
@@ -62,6 +62,23 @@
 //!     .parse()
 //!     .emit();
 //! ```
+//!
+//! ## Getting C/C++ include paths from Conan dependencies
+//!
+//! To use the list of include paths, do the following after
+//! parsing the `conan install` output:
+//!
+//! ```no_run
+//! use conan2::ConanInstall;
+//!
+//! let metadata = ConanInstall::new().run().parse();
+//!
+//! for path in metadata.include_paths() {
+//!     // Add "-I{path}" to CXXFLAGS or something.
+//! }
+//!
+//! metadata.emit();
+//! ```
 
 #![deny(missing_docs)]