summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKeith Short <keithshort@chromium.org>2022-02-18 12:49:11 -0700
committerCommit Bot <commit-bot@chromium.org>2022-02-18 22:40:55 +0000
commit76f3945dcfba32d35f199cf18aa722e5be3999dd (patch)
tree1b8a7be39434515d83ca77b3c3d6b9b9c4a75d7a /README.md
parent5a21aa1779e526d4506658890f9d440d0ce294b2 (diff)
downloadchrome-ec-76f3945dcfba32d35f199cf18aa722e5be3999dd.tar.gz
zephyr: docs: Add introduction section
Update the legacy README.md to define "legacy EC" vs "Zephyr EC". Add an Zephyr EC introduction section. BUG=b:207403708 BRANCH=none TEST=view docs with gerrit browse Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I966102d901b516e665d3a6034709cdfc120b5d0a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3474634 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 84eb5af70c..d0f3aa9eb5 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
[TOC]
+> **Note** - This document covers the legacy Chrome EC implementation. The
+> legacy EC implementation is used by all Chromebook reference designs prior to
+> July 2021. On newer Chromebook designs, the EC implementation is based on the
+> Zephyr RTOS. Refer to the [Zephyr EC Introduction](./docs/zephyr/README.md)
+> for details on the Zephyr EC implementation.
+
## Introduction
The Chromium OS project includes open source software for embedded controllers