clp

Crates.ioclp
lib.rsclp
version0.5.0
sourcesrc
created_at2023-04-14 02:38:50.893309
updated_at2023-04-17 17:43:21.01947
descriptionSimple library for creating "command line presentations".
homepage
repositoryhttps://github.com/valentinegb/clp
max_upload_size
id838882
size143,088
Valentine Briese (valentinegb)

documentation

README

clp

Simple library for creating "command line presentations".

clp_presentation example video

Presentations are composed with the slide macro, like so:

use clp::{crossterm, slide, TypewriterPrint, TypewriterPrintStyledContent};
use crossterm::style::{Print, Stylize};
use std::time::Duration;

slide!(
    TypewriterPrint("Welcome to my presentation on ", Duration::from_millis(25)),
    TypewriterPrintStyledContent(
        "command line presentations".bold(),
        Duration::from_millis(50),
    ),
    Print("."),
)
.expect("the first slide should appear");

slide!(TypewriterPrint(
    "\n...there isn't much content on these slides.",
    Duration::from_millis(25),
))
.expect("the second slide should appear");

Features

This package has one feature: spin_sleep. It enables the spin_sleep dependency, which is a more accurate drop-in replacement for the sleep function. It's particularly useful on Windows, which has a notoriously inaccurate sleep function. If you notice that TypewriterPrint or TypewriterPrintStyledContent is slower than expected, you should enable the spin_sleep feature.

cargo add clp -F spin_sleep
Commit count: 37

cargo fmt