Skip to content

Commit 42d3c6a

Browse files
committed
Add screenshot
1 parent 1002f6d commit 42d3c6a

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ A simple, clean serial monitor with a clean terminal UI for embedded development
88

99
Most terminal-based serial monitors are annoying to use - they have clunky interfaces and no sane defaults. We wanted something that could be quickly spun up to interact with embedded devices during firmware development without any hassle.
1010

11+
![Screenshot](./docs/screenshot.png)
12+
1113
## Features
1214

1315
- **Smart auto-scroll**: Follows new data, easy to switch to manual scrolling
@@ -21,14 +23,17 @@ Most terminal-based serial monitors are annoying to use - they have clunky inter
2123
## Quick Start
2224

2325
```bash
24-
# Install from source (until published to crates.io)
26+
# Install from crates.io
27+
cargo install sermonizer
28+
29+
# Install from source
2530
git clone https://github.com/systemscape/sermonizer.git
2631
cd sermonizer
27-
cargo run --release
28-
29-
# Or install locally
3032
cargo install --path .
3133

34+
# Or run locally
35+
cargo run --release
36+
3237
# Connect to first available port
3338
sermonizer
3439

docs/screenshot.png

40.3 KB
Loading

0 commit comments

Comments
 (0)