crcrcr reads your folder contents to create some slides in your terminal.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Siegfried Ehret 4c8d5b493f :wrench: update push script 1 month ago
slides :memo: update example 1 month ago
src :gift: Allow to fix the width of slides, centered in the terminal 1 month ago
.gitignore :wrench: add gitignore 1 month ago
CHANGELOG.md :memo: update changelog 1 month ago
LICENSE :unlock: add license 1 month ago
Makefile :wrench: update push script 1 month ago
README.md :memo: add mirrors in readme 1 month ago
VERSION :arrow_up: bump version 1 month ago
shard.lock :rocket: add code 1 month ago
shard.yml :rocket: add code 1 month ago

README.md

crcrcr

crcrcr reads your folder contents to create some slides in your terminal.

:warning: very experimental, but it works (sometimes) on my computer.

Usage

Just run crcrcr in your folder and voilà!

Here is a sample structure:

my-slides/
├── 01-intro/
│   ├── 01-intro.txt
│   └── 02-whoami.txt
├── 02-what
│   ├── 01-slides.txt
│   └── 02-terminal.txt
└── 00.txt

The slides are ordered alphabetically, so the order is:

  • 00.txt
  • 01-intro/01-intro.txt
  • 01-intro/02-whoami.txt
  • 02-what/01-slides.txt
  • 02-what/02-terminal.txt

Possible flags:

  • -w 50 or --width=50: fix the width of the slides. They will be centered in the terminal.

Known issues

  • :bug: Crashes when the terminal is resized and the content reaches the borders.

Development

crcrcr is made with Crystal.

Code available on:

License

Licensed under the GPLv3 license.