Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 4.39 KB

README.md

File metadata and controls

93 lines (60 loc) · 4.39 KB
Raw

Conan Center Index is the source index of recipes of the ConanCenter package repository for Conan.

This repository includes a Continuous Integration system that will build automatically the Conan packages for the recipes submitted via Pull Request.

Server Status

The current Conan Center Index CI status can be found on https://status.conan.io/

Any maintenance, outage or important event related to the CI will be informed there.

Configure the Conan Center remote

Important

The Conan Center remote URL changed for Conan 2 on November 2024 - the new URL is the default on new installations of Conan since version 2.9.2.

New recipe updates are only published to this remote and are only guaranteed to be compatible with recent versions of Conan 2.

All previously published recipes and packages known to be compatible with Conan 2 are also served by this remote.

To update an existing Conan 2 installation:

conan remote update conancenter --url https://center2.conan.io

Conan Center legacy remote

The legacy remote at https://center.conan.io stopped receiving updates on 4 November 2024 and is frozen and will no longer received updates. It is kept in this state to avoid breaking any existing Conan 1.x installations.

How to consume recipes

Starting to use recipes from this repository is as easy as running one simple command after installing Conan:

conan install --require=name/version [-g <generator>]

For further details, please see the Conan documentation.

⚠️ It is very important to notice that recipes will evolve over time and, while they are fixing some issues, they might introduce new features and improvements, and your project can break if you upgrade them (How to prevent these breaking changes in my project?).

Documentation

All the documentation is available in this same repository in the docs/ subfolder.

This is a list of shortcuts to some interesting topics:

Reporting Issues

You can open issues in the issue tracker to:

  • 🐛 Report bugs/issues in a package:

    • Use the [package] tag in the title of the issue to help identifying them.
    • If you detect any issue or missing feature in a package, for example, a build failure or a recipe that not support a specific configuration.
    • Specify the name and version (zlib/1.2.11) and any relevant details about the fail configuration: Applied profile, building machine...

  • 💡 Request a new library to be added:

    • Use the [request] label to search the library in the issue tracker in case it was already requested.
    • If not, use the same [request] tag in the title of the issue to help identifying them.
    • Indicate the name and the version of the library you would like to have in the repository. Also links to the project's website, source download/repository and in general any relevant information that helps creating a recipe for it.

  • 🤖 Report a failure in the CI system:

    • If you open a Pull Request and get an unexpected error you might comment in the failing PR.
    • If the service or repository is down or failing, use the [service] tag in the title of a new issue to help identifying them.

If your issue is not appropriate for a public discussion, please contact us via e-mail at [email protected]. Thanks!

License

All the Conan recipes in this repository are distributed under the MIT license. There are other files, like patches or examples used to test the packages, that could use different licenses, for those files specific license and credit must be checked in the file itself.