core/README.md.erb at main · esp-idf-lib/core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# The core repository of `esp-idf-lib`

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                                                                                                                                         |
| -------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| ESP32-xx | ESP-IDF          | All officially supported versions (see [Support Period Policy](https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md)) and `master` |

## Purpose

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

* Documenting common policies and rules
* Discussions about our components
* Linking all the components and their [status](https://esp-idf-lib.github.io/core/status.html)

## Reporting issues in our component

When the issue is bug in the component, please open an Issue in the component
repository.

## Questions or discussions

For questions or discussions, use [discussions](https://github.com/esp-idf-lib/core/discussions) in this
repository.

## Documentation

- [How to contribute to `esp-idf-lib`](https://github.com/esp-idf-lib/core/blob/main/CONTRIBUTING.md)
- [Frequently asked questions](https://github.com/esp-idf-lib/core/blob/main/FAQ.md)

## Requesting new driver

TBW

## Components

Components for Espressif ESP32 [ESP-IDF framework](https://github.com/espressif/esp-idf)
and [ESP8266 RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK).

Part of them ported from [esp-open-rtos](https://github.com/SuperHouse/esp-open-rtos).

<% groups.each do |group| %>
### <%= group["description"] %>

| Name | Description |
|------|-------------|
<% components.select { |c| c.group_of? group["name"] }.each do |c| %>
| [<%= c.name %>](<%= c.repo_url %>) <br> <%= c.badge_esp_component_registry %> | <%= c.description %> ([Documentation](<%= c.doc_url %>)) |
<% end %>

<% end %>

## Contributors

<% persons.each do |person| %>
  - <%= person_credit(person) %> <%= person_contribution(person) %>
<% end %>