Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Remove defmt-raw docs #79

Merged
merged 1 commit into from
Dec 21, 2023
Merged
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ logging capabilities for Espressif devices.
# Usage

```toml
esp-println = { version = "0.7.0", features = ["esp32c2"] }
esp-println = { version = "0.8.0", features = ["esp32c2"] }
```
or `cargo add esp-println --features esp32c2`
It's important to specify your target device as feature.
Expand Down Expand Up @@ -76,10 +76,6 @@ output to the same data stream as `println!()`, and adds framing bytes so it can
other, non-defmt output. Using the `defmt-espflash` feature automatically uses the Rzcobs encoding and does
not allow changing the encoding.

You can also use the `defmt-raw` feature that allows using any encoding provided by `defmt`, but
does not add extra framing. Using this feature requires some care as the `defmt` output may become
unrecoverably mangled when other data is printed.

Follow the [`defmt` book's setup instructions] on how to
set up `defmt`. Remember, the global logger is already installed for you by `esp-println`!

Expand Down