Skip to content

Add note about migration #47

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

Merged
trombik merged 1 commit into from
Aug 12, 2025
Merged

Add note about migration #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This is the core repository of [esp-idf-lib](https://github.com/esp-idf-lib/). The organization is the successor of [UncleRus/esp-idf-lib](https://github.com/UncleRus/esp-idf-lib).

> [!NOTE]
>
> When migrating from [UncleRus/esp-idf-lib](https://github.com/UncleRus/esp-idf-lib) do not add this repository as a dependency.
> Instead, add individual components as [ESP-IDF components](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/tools/idf-component-manager.html) in your `idf_component.yml`.
> You can find all components on the [ESP Component Registry](https://components.espressif.com/components?q=namespace%3Aesp-idf-lib).

## Supported versions of frameworks and devices

| Chip | Framework | Versions |
Expand All @@ -10,7 +16,7 @@ This is the core repository of [esp-idf-lib](https://github.com/esp-idf-lib/). T

## Purpose

The purpose of [esp-idf-lib/core](https://github.com/esp-idf-lib/core)is:
The purpose of [esp-idf-lib/core](https://github.com/esp-idf-lib/core) is:

* Documenting common policies and rules
* Discussions about our components
Expand Down
8 changes: 7 additions & 1 deletion README.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This is the core repository of [esp-idf-lib](https://github.com/esp-idf-lib/). The organization is the successor of [UncleRus/esp-idf-lib](https://github.com/UncleRus/esp-idf-lib).

> [!NOTE]
>
> When migrating from [UncleRus/esp-idf-lib](https://github.com/UncleRus/esp-idf-lib) do not add this repository as a dependency.
> Instead, add individual components as [ESP-IDF components](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/tools/idf-component-manager.html) in your `idf_component.yml`.
> You can find all components on the [ESP Component Registry](https://components.espressif.com/components?q=namespace%3Aesp-idf-lib).

## Supported versions of frameworks and devices

| Chip | Framework | Versions |
Expand All @@ -10,7 +16,7 @@ This is the core repository of [esp-idf-lib](https://github.com/esp-idf-lib/). T

## Purpose

The purpose of [esp-idf-lib/core](https://github.com/esp-idf-lib/core)is:
The purpose of [esp-idf-lib/core](https://github.com/esp-idf-lib/core) is:

* Documenting common policies and rules
* Discussions about our components
Expand Down