Skip to content
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.

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

docs: tweak readme #1419

Merged
merged 3 commits into from
Oct 15, 2024
Merged

docs: tweak readme #1419

merged 3 commits into from
Oct 15, 2024

Conversation

joshka
Copy link
Member

@joshka joshka commented Oct 15, 2024

Fixes: #1417

@joshka joshka requested a review from a team as a code owner October 15, 2024 03:05
@joshka
Copy link
Member Author

joshka commented Oct 15, 2024

The main goal of this is to move the info on how to get started up a bit and to fill out some info / tighten up some of the language.

Screen Shot 2024-10-14 at 20 07 00

Copy link

github-actions bot commented Oct 15, 2024

🐰 Bencher Report

Branch1419/merge
Testbedubuntu-latest

⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
barchart/render/2048📈 view plot
⚠️ NO THRESHOLD
193,630.00
barchart/render/256📈 view plot
⚠️ NO THRESHOLD
133,070.00
barchart/render/64📈 view plot
⚠️ NO THRESHOLD
84,990.00
barchart/render_grouped/2048📈 view plot
⚠️ NO THRESHOLD
337,150.00
barchart/render_grouped/256📈 view plot
⚠️ NO THRESHOLD
139,380.00
barchart/render_grouped/64📈 view plot
⚠️ NO THRESHOLD
128,100.00
barchart/render_horizontal/2048📈 view plot
⚠️ NO THRESHOLD
163,320.00
barchart/render_horizontal/256📈 view plot
⚠️ NO THRESHOLD
85,690.00
barchart/render_horizontal/64📈 view plot
⚠️ NO THRESHOLD
77,173.00
block/render_all_feature/100x50📈 view plot
⚠️ NO THRESHOLD
11,385.00
block/render_all_feature/200x50📈 view plot
⚠️ NO THRESHOLD
19,882.00
block/render_all_feature/256x256📈 view plot
⚠️ NO THRESHOLD
94,546.00
block/render_empty/100x50📈 view plot
⚠️ NO THRESHOLD
6,249.90
block/render_empty/200x50📈 view plot
⚠️ NO THRESHOLD
12,300.00
block/render_empty/256x256📈 view plot
⚠️ NO THRESHOLD
80,571.00
buffer/empty/16📈 view plot
⚠️ NO THRESHOLD
790.57
buffer/empty/255📈 view plot
⚠️ NO THRESHOLD
221,050.00
buffer/empty/64📈 view plot
⚠️ NO THRESHOLD
13,434.00
buffer/filled/16📈 view plot
⚠️ NO THRESHOLD
785.72
buffer/filled/255📈 view plot
⚠️ NO THRESHOLD
213,940.00
buffer/filled/64📈 view plot
⚠️ NO THRESHOLD
13,171.00
buffer/with_lines/16📈 view plot
⚠️ NO THRESHOLD
16,668.00
buffer/with_lines/255📈 view plot
⚠️ NO THRESHOLD
14,773.00
buffer/with_lines/64📈 view plot
⚠️ NO THRESHOLD
16,568.00
line_render/Center/0📈 view plot
⚠️ NO THRESHOLD
3.73
line_render/Center/10📈 view plot
⚠️ NO THRESHOLD
631.86
line_render/Center/3📈 view plot
⚠️ NO THRESHOLD
298.49
line_render/Center/4📈 view plot
⚠️ NO THRESHOLD
340.40
line_render/Center/42📈 view plot
⚠️ NO THRESHOLD
852.42
line_render/Center/6📈 view plot
⚠️ NO THRESHOLD
403.86
line_render/Center/7📈 view plot
⚠️ NO THRESHOLD
457.02
line_render/Left/0📈 view plot
⚠️ NO THRESHOLD
3.73
line_render/Left/10📈 view plot
⚠️ NO THRESHOLD
597.91
line_render/Left/3📈 view plot
⚠️ NO THRESHOLD
231.59
line_render/Left/4📈 view plot
⚠️ NO THRESHOLD
245.34
line_render/Left/42📈 view plot
⚠️ NO THRESHOLD
849.56
line_render/Left/6📈 view plot
⚠️ NO THRESHOLD
391.23
line_render/Left/7📈 view plot
⚠️ NO THRESHOLD
404.07
line_render/Right/0📈 view plot
⚠️ NO THRESHOLD
3.73
line_render/Right/10📈 view plot
⚠️ NO THRESHOLD
567.62
line_render/Right/3📈 view plot
⚠️ NO THRESHOLD
276.00
line_render/Right/4📈 view plot
⚠️ NO THRESHOLD
332.52
line_render/Right/42📈 view plot
⚠️ NO THRESHOLD
853.69
line_render/Right/6📈 view plot
⚠️ NO THRESHOLD
445.29
line_render/Right/7📈 view plot
⚠️ NO THRESHOLD
500.54
list/render/16384📈 view plot
⚠️ NO THRESHOLD
1,192,200.00
list/render/2048📈 view plot
⚠️ NO THRESHOLD
329,200.00
list/render/64📈 view plot
⚠️ NO THRESHOLD
215,880.00
list/render_scroll_half/16384📈 view plot
⚠️ NO THRESHOLD
1,207,300.00
list/render_scroll_half/2048📈 view plot
⚠️ NO THRESHOLD
333,130.00
list/render_scroll_half/64📈 view plot
⚠️ NO THRESHOLD
147,990.00
paragraph/new/2048📈 view plot
⚠️ NO THRESHOLD
259,540.00
paragraph/new/64📈 view plot
⚠️ NO THRESHOLD
6,888.00
paragraph/new/65535📈 view plot
⚠️ NO THRESHOLD
8,145,900.00
paragraph/render/2048📈 view plot
⚠️ NO THRESHOLD
616,250.00
paragraph/render/64📈 view plot
⚠️ NO THRESHOLD
582,900.00
paragraph/render/65535📈 view plot
⚠️ NO THRESHOLD
1,797,900.00
paragraph/render_scroll_full/2048📈 view plot
⚠️ NO THRESHOLD
612,970.00
paragraph/render_scroll_full/64📈 view plot
⚠️ NO THRESHOLD
611,390.00
paragraph/render_scroll_full/65535📈 view plot
⚠️ NO THRESHOLD
1,803,700.00
paragraph/render_scroll_half/2048📈 view plot
⚠️ NO THRESHOLD
618,340.00
paragraph/render_scroll_half/64📈 view plot
⚠️ NO THRESHOLD
626,120.00
paragraph/render_scroll_half/65535📈 view plot
⚠️ NO THRESHOLD
1,808,400.00
paragraph/render_wrap/2048📈 view plot
⚠️ NO THRESHOLD
296,030.00
paragraph/render_wrap/64📈 view plot
⚠️ NO THRESHOLD
259,730.00
paragraph/render_wrap/65535📈 view plot
⚠️ NO THRESHOLD
1,475,500.00
paragraph/render_wrap_scroll_full/2048📈 view plot
⚠️ NO THRESHOLD
298,070.00
paragraph/render_wrap_scroll_full/64📈 view plot
⚠️ NO THRESHOLD
259,290.00
paragraph/render_wrap_scroll_full/65535📈 view plot
⚠️ NO THRESHOLD
1,474,000.00
rect_rows/rows/1024📈 view plot
⚠️ NO THRESHOLD
324.97
rect_rows/rows/16📈 view plot
⚠️ NO THRESHOLD
5.60
rect_rows/rows/65535📈 view plot
⚠️ NO THRESHOLD
20,478.00
sparkline/render/2048📈 view plot
⚠️ NO THRESHOLD
113,680.00
sparkline/render/256📈 view plot
⚠️ NO THRESHOLD
111,490.00
sparkline/render/64📈 view plot
⚠️ NO THRESHOLD
35,664.00
table/render/16384x2📈 view plot
⚠️ NO THRESHOLD
2,957,200.00
table/render/16384x4📈 view plot
⚠️ NO THRESHOLD
5,715,600.00
table/render/16384x8📈 view plot
⚠️ NO THRESHOLD
16,407,000.00
table/render/2048x2📈 view plot
⚠️ NO THRESHOLD
657,620.00
table/render/2048x4📈 view plot
⚠️ NO THRESHOLD
1,120,500.00
table/render/2048x8📈 view plot
⚠️ NO THRESHOLD
1,815,700.00
table/render/64x2📈 view plot
⚠️ NO THRESHOLD
357,140.00
table/render/64x4📈 view plot
⚠️ NO THRESHOLD
536,100.00
table/render/64x8📈 view plot
⚠️ NO THRESHOLD
629,540.00
table/render_scroll_half/16384x2📈 view plot
⚠️ NO THRESHOLD
2,896,800.00
table/render_scroll_half/16384x4📈 view plot
⚠️ NO THRESHOLD
5,518,500.00
table/render_scroll_half/16384x8📈 view plot
⚠️ NO THRESHOLD
16,312,000.00
table/render_scroll_half/2048x2📈 view plot
⚠️ NO THRESHOLD
673,320.00
table/render_scroll_half/2048x4📈 view plot
⚠️ NO THRESHOLD
1,128,600.00
table/render_scroll_half/2048x8📈 view plot
⚠️ NO THRESHOLD
1,811,800.00
table/render_scroll_half/64x2📈 view plot
⚠️ NO THRESHOLD
232,700.00
table/render_scroll_half/64x4📈 view plot
⚠️ NO THRESHOLD
346,930.00
table/render_scroll_half/64x8📈 view plot
⚠️ NO THRESHOLD
410,190.00
🐰 View full continuous benchmarking report in Bencher

@kdheepak
Copy link
Collaborator

kdheepak commented Oct 15, 2024

Btw, the screenshots look weird in light mode.

I’d be okay dropping the color example and replacing the screenshots with ascii text.

@joshka joshka force-pushed the jm/readme-init branch 3 times, most recently from bf38135 to d970c19 Compare October 15, 2024 09:13
@joshka
Copy link
Member Author

joshka commented Oct 15, 2024

Doc Test failures fixed in #1421

@joshka joshka merged commit 4728f0e into main Oct 15, 2024
33 of 38 checks passed
@joshka joshka deleted the jm/readme-init branch October 15, 2024 10:00
kdheepak added a commit that referenced this pull request Oct 16, 2024
* origin/main: (21 commits)
  perf: implement size hints for `Rect` iterators (#1420)
  fix(color): fix doc test for from_hsl (#1421)
  docs: tweak readme (#1419)
  refactor(color)!: use palette types for Hsl/Hsluv conversions (#1418)
  chore(deps)!: pin unicode-width to 0.2.0 (#1403)
  feat(scrolling-regions)!: use terminal scrolling regions to stop Terminal::insert_before from flickering (#1341)
  feat!: add an impl of `DoubleEndedIterator` for `Columns` and `Rows` (#1358)
  fix(rect)!: Rect::area now returns u32 and Rect::new() no longer clamps area to u16::MAX (#1378)
  docs: fix missing breaking changes link (#1416)
  feat(line)!: impl From<Cow<str>> for Line (#1373)
  chore(deny): allow Zlib license in cargo-deny configuration (#1411)
  feat(tabs)!: allow tabs to be deselected (#1413)
  feat(color): add hsluv support (#1333)
  feat(table)!: add support for selecting column and cell (#1331)
  feat(text): improve concise debug view for Span,Line,Text,Style (#1410)
  chore: add benchmark for `Table` (#1408)
  refactor: Consistent result expected in layout tests (#1406)
  feat(logo): Add a Ratatui logo widget
  chore(deps): update rstest requirement from 0.22.0 to 0.23.0 (#1394)
  chore(deps): update octocrab requirement from 0.40.0 to 0.41.0 (#1393)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README.md example to use new ratatui::init() function
2 participants