Skip to content

Commit f72df29

Browse files
committed
docs(readme): update readme with timer system documentation
- Add timer feature description to main features list - Add `t` key binding documentation for timer toggle - Add timer display section explaining total and per-slide timing - Document automatic timer behavior during slide transitions
1 parent e180b9b commit f72df29

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ A terminal-based presentation tool that creates beautiful presentations from mar
3232
- **Theme support**: Choose from built-in Glamour themes or load custom JSON theme files
3333
- **Flexible layouts**: Center, align, and position content with various layout options
3434
- **Simple navigation**: Intuitive keyboard controls for presentation flow (vim style btw)
35+
- **Presentation timer**: Built-in timer system with per-slide and global timing
36+
- Toggle timer display with a single key
37+
- Track time spent on each slide
38+
- Monitor total presentation duration
39+
- Automatic pause/resume during slide transitions
3540

3641
## Installation
3742

@@ -69,6 +74,7 @@ kyma version
6974
- **Next slide**: ``, `l`, or `Space`
7075
- **Previous slide**: `` or `h`
7176
- **Quit**: `q`, `Esc`, or `Ctrl+C`
77+
- **Toggle timer**: `t` - Shows/hides the timer display with total and per-slide timing
7278

7379
## Configuration
7480

@@ -145,6 +151,21 @@ style:
145151
146152
Layout can also be specified as a combination: `layout: center,right`
147153

154+
### Timer Display
155+
156+
The timer display shows two timing metrics:
157+
158+
- **Total**: The total duration of the presentation
159+
- **Slide**: The time spent on the current slide
160+
161+
The timer display appears as an overlay in the top-left corner of the screen when toggled with the `t` key. The timer automatically:
162+
163+
- Starts when the presentation begins
164+
- Pauses when switching slides
165+
- Resumes when a new slide is displayed
166+
- Maintains separate timing for each slide
167+
- Preserves timing state during navigation
168+
148169
### Global Configuration
149170

150171
Kyma supports a global configuration file that can be used to set default styles and create named presets. The configuration file can be placed in either:

0 commit comments

Comments
 (0)