Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for remote #25866

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Update documentation for remote #25866

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fb5f60
Update documentation for remote
jcar87 Nov 7, 2024
188bfd8
Formatting
jcar87 Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,35 @@ 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.


### Add ConanCenter remote
### Configure the Conan Center remote

ConanCenter remote is configured by default in any Conan client installation. If, for any reason, you need to add it manually, just execute:
> [!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 add conancenter https://center.conan.io
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 name/version@ [-g <generator>]
conan install --require=name/version [-g <generator>]
```

Of course, we really encourage you to use a `conanfile.txt` or `conanfile.py`
to list all the requirements or your project and install them all together
(Conan will build a single graph and ensure congruency).
For further details, please see the [Conan documentation](https://docs.conan.io/2/tutorial/consuming_packages.html).

:warning: 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
Expand Down
Loading