File tree Expand file tree Collapse file tree 2 files changed +35
-1
lines changed Expand file tree Collapse file tree 2 files changed +35
-1
lines changed Original file line number Diff line number Diff line change 11# tui-slides
2- Terminal Presentation program with modern TUI
2+ Terminal Presentation tool with modern TUI capable to render images in terminal and with many more widgets.
3+
4+ <img src =" ./tui-slides.png " width =" 100 " />
5+
6+ ## Install via cargo
7+ ```
8+ cargo install tui-slides
9+ ```
10+
11+ ## Usage
12+ To create new presentation You have to create a folder with JSON file where you can create Your presentation slides.
13+ Example file is here.
14+
15+ ## Run
16+ To start ` tui-slides ` we just call it with argument ` -j ` where we specify path to JSON file with slides data.
17+ ```
18+ tui-slides -j="./path_to_slides/slides.json"
19+ ```
20+
21+ ### JSON: root
22+ Main section of slide config is ` box_size ` . Here we set fixed size of content box.
23+ ```
24+ "box_size": { "width": 50, "height": 50 }
25+ ```
26+
27+ ### JSON: slides
28+ ` slides ` property is defining content. Slide content have it's ` type ` , ` content ` , ` rect ` & ` color ` .
29+ There are few types at the moment but in the future there should be support for every widget in Ratatui library.
30+ Supported widgets ATM:
31+ - Image
32+ - Block
33+ - Paragraph
34+ - Line
35+ - Bigtext
36+
You can’t perform that action at this time.
0 commit comments