Git slide deck

Git Slide deck can turn your codebase into a slide-deck. Ideal for small projects that are the topic of a workshop / live coding session. You can create slides by creating commits, and then present them by stepping through the commits. You'll use your favorite Editor as Presenting tool, and use this terminal app for slide navigation.

Used for: https://github.com/matthijsgroen/build-react-redux

The tool produces a .slide-deck.json which contains an array of your slides with name and commit hash. you can edit this file to update your slide names or reorder them.

Installation

npm install -g git-slide-deck

Usage from command line

Usage: git-slide-deck [options] [command]

Turns your codebase in a slide-deck. Ideal for workshops or partly live coding sessions

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  init            initialize a slide-deck file
  add <name>      adds current commit as new slide
  update          updates current slide to current commit
  next            stashes changes and goes to the next slide
  previous        stashes changes and goes to the previous slide
  first           stashes changes and goes to the first slide
  present         plays entire deck as client, starting from the first slide
  edit            start editor as client, to quickly add/update slides
  help [command]  display help for command

Licence

The code is licensed under MIT (see LICENSE file).

Contributing

Thanks for your interest in contributing! There are many ways to contribute to this project. Get started here