Skip to content

docs: CI badge, update URL #1

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
swoisz merged 1 commit into from
Apr 7, 2026
Merged

docs: CI badge, update URL #1

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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Boreas

[![CI](https://github.com/intercreate/boreas/actions/workflows/ci.yml/badge.svg)](https://github.com/intercreate/boreas/actions/workflows/ci.yml)

Zephyr-compatible kernel APIs and device model for ESP-IDF.

Boreas provides a thin, tested abstraction layer that brings Zephyr RTOS API conventions to ESP-IDF projects running on FreeRTOS. Named for the Greek god of the north wind -- a sibling to Zephyr (west wind).
Expand All @@ -18,7 +20,7 @@ Add Boreas to your ESP-IDF project as a git submodule or local path:

```bash
# As submodule
git submodule add <repo-url> components/boreas
git submodule add https://github.com/intercreate/boreas.git components/boreas

# In your top-level CMakeLists.txt
set(EXTRA_COMPONENT_DIRS components/boreas/components)
Expand Down
Loading