https://github.com/conan-io/examples

Conan 1.x examples
https://github.com/conan-io/examples

Last synced: about 1 month ago
JSON representation

Conan 1.x examples

• Host: GitHub
• URL: https://github.com/conan-io/examples
• Owner: conan-io
• License: mit
• Created: 2019-02-22T18:53:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-16T11:29:28.000Z (over 1 year ago)
• Last Synced: 2024-09-27T06:41:29.913Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 2.03 MB
• Stars: 124
• Watchers: 19
• Forks: 66
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-conan - Conan Examples

README

        
[![Build Status](https://ci.conan.io/buildStatus/icon?job=Examples/master)](https://ci.conan.io/job/Examples/job/master/)

> :warning: **Important**: These examples are for Conan 1.X. For the latest version of the

> examples, compatible with Conan 2.X, please refer to the [new

> repository](https://github.com/conan-io/examples2).

# Conan 1.X Examples

Several Conan 1.X examples to complement the documentation and blog.

## Examples

### [Getting started with Conan](libraries/poco/md5)

Example how to use Conan to consume binaries.

Documentation: https://docs.conan.io/en/latest/getting_started.html

### [Package development flow](features/package_development_flow)

Example how to use Conan commands to develop a package recipe.

Documentation: https://docs.conan.io/en/latest/developing_packages/package_dev_flow.html

### [Workspace](features/workspace)

Example how to use Conan Workspaces.

Documentation: https://docs.conan.io/en/latest/developing_packages/workspaces.html

### [Editable Packages](features/editable)

Example how to use Conan Editable Packages.

Documentation: https://docs.conan.io/en/latest/developing_packages/editable_packages.html

### [Serializing your data with Protobuf](libraries/protobuf/serialization)

Demonstrate how to use Protobuf to serialize data between C++ and Python.

Blog Post: https://blog.conan.io/2019/03/06/Serializing-your-data-with-Protobuf.html

### [Using Facebook Folly with Conan](libraries/folly/basic)

Demonstrate how to use Folly to validate an URI using Futures, FBString, Executors, and Format.

Blog Post: https://blog.conan.io/2018/12/03/Using-Facebook-Folly-with-Conan.html

### [An introduction to Dear ImGui and how to use with Conan](libraries/dear-imgui/basic)

Demonstrate how to use Dear ImGui with Conan to add a GUI to an OpenGL3 application.

### [Exporting targets with CMake and reuse with find_package()](features/cmake/find_package/exported_targets_multiconfig)

Use CMake to declare, export and install the targets of some libraries and using Conan to reuse them with

``find_package`` and the multi-configuration project.

### [Using the cmake_find_package_multi generator](features/cmake/find_package/find_cmake_multi_generator_targets)

Demonstrate how to use the ``cmake_find_package_multi`` generator to integrate seamlessly CMake with Conan

using ``find_package`` in a multi-configuration project.

### [Multi-configuration package (N configs -> 1 package)](features/multi_config)

Example on how to create multi-configuration debug/release packages covering the N configs -> 1 package use case:

- Remove the ``build_type`` from settings.

- Have a CMake script that differentiate debug and release artifacts (``set_target_properties(hello PROPERTIES DEBUG_POSTFIX _d)``).

- Have a ``build()`` that builds both configs.

- Have a ``package_info()`` method that accounts for both configs ``self.cpp_info.debug.libs``, etc.

Documentation: https://docs.conan.io/en/latest/creating_packages/package_approaches.html#n-configs-1-package

### Lockfiles

#### [Using lockfiles in CI to rebuild a whole project](features/lockfiles/ci)

When a package in a dependency graph is modified and a new version or revision is created, it

is sometimes desired to test if that new version works well within a larger product or project,

that is, when that package is part of a larger dependency graph. The packages that depend on

the modified one might need to be rebuilt, but if something else changed, it is impossible to

achieve reproducible builds.

Using lockfiles can enforce the same upstream dependencies, to ensure reproducible builds and to re-build and test such scenarios.

Documentation: https://docs.conan.io/en/latest/versioning/lockfiles.html#how-to-use-lockfiles-in-ci

### [Integrate a build system in Conan](features/integrate_build_system)

Shows how to integrate a build-system in Conan using an *installer*, a *build-helper* and a *custom generator*.

### [Deployment](features/deployment)

Shows how to use conan ``json`` generator with custom script to automate the creation of deployable artifact ([makeself.io](https://makeself.io))

Documentation: https://docs.conan.io/en/laters/integrations/deployment.html

## How can I reproduce the build steps?

All our examples can be built on Windows, Linux and Mac. If you are interested to reproduce

the examples in your environment, please check the scripts inside every example folder.

## LICENSE

[MIT](LICENSE)