skit

README

Skit

a basic presentation app for the command line

→ next slide

← previous slide

Ctrl-C to quit

Table Of Contents

• Table Of Contets
• Features
  • Syntax
• Contributing
• Inspiration
• License

Features

Syntax

• Each paragraph marks a slide.
• Text is just starts at the beginning of a line.
• If the first character is a / a control sequence is expected, except if another /, then it's just a / as text:
  • # -> Slide title, required.
  • @ -> Path to image, optional. A slide shows either an image or text.
  • _ -> Background color, between 0 and 255.
  • ^ -> Foreground color, between 0 and 255.
  • ! -> Comment, is parsed but ignored for now.
• The colors are ignored for images, since images are in ascii and need a black background.

See example.skt.

Images

This program supports the following file types:

• .jpg
• .png

Themes

• Two color themes:
  • Foreground: #ffffff by default
  • Background: #000000 by default

Installing and Contributing

Install with:

go get github.com/jpeinelt/skit

Contributions are always welcome

Inspiration

General Idea

zeichma - A dear colleague of mine came up with the idea to have a really simple presentation software. Thank you Karl!

Lexer and Parser

Lexing in Go - Rob Pike Talking about Lexing

Ini Parser - Simple Parser, also inspired by Rob Pike's talk

UI

slack-term - Slack client for the CLI

License

Copyright © 2018 Julius Peinelt

This software is distributed under the terms of the Apache License Version 2.0 (Apache-2.0). For details see LICENSE.