From 2012760b7d225fe401d01fc879f95321e518e4ec Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 7 Aug 2020 11:55:50 +0200 Subject: [PATCH] wire format is still unstable --- README.md | 4 ++++ book/src/introduction.md | 4 ++++ src/lib.rs | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/README.md b/README.md index de3d3516..ddee9ca4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # `binfmt` +> **PRE-ALPHA PREVIEW** `binfmt` wire format has not been finalized yet. When +> using the framework make sure you use the *same* "version" (commit hash) for +> all components (target side and host side). + A highly efficient logging framework that targets resource-constrained devices, like microcontrollers. For more details check the book at https://binfmt.ferrous-systems.com diff --git a/book/src/introduction.md b/book/src/introduction.md index 5fcf955d..085c0216 100644 --- a/book/src/introduction.md +++ b/book/src/introduction.md @@ -1,5 +1,9 @@ # `binfmt` +> **PRE-ALPHA PREVIEW** `binfmt` wire format has not been finalized yet. When +> using the framework make sure you use the *same* "version" (commit hash) for +> all components (target side and host side). + `binfmt` is a highly efficient logging framework that targets resource-constrained devices, like microcontrollers. ## Features diff --git a/src/lib.rs b/src/lib.rs index 8bdce3dd..bd687d4e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,9 @@ //! `binfmt` //! +//! > **PRE-ALPHA PREVIEW** `binfmt` wire format has not been finalized yet. When using the +//! > framework make sure you use the *same* "version" (commit hash) for all components (target side +//! > and host side). +//! //! A highly efficient logging framework that targets resource-constrained devices, like //! microcontrollers. //!