https://github.com/matthijsgroen/git-slide-deck

Turn your Git Project into a slideshow!
https://github.com/matthijsgroen/git-slide-deck

git live-coding presentation-slides

Last synced: 11 days ago
JSON representation

Turn your Git Project into a slideshow!

• Host: GitHub
• URL: https://github.com/matthijsgroen/git-slide-deck
• Owner: matthijsgroen
• License: mit
• Created: 2022-05-17T10:09:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-25T07:36:19.000Z (over 2 years ago)
• Last Synced: 2025-01-08T08:26:22.200Z (17 days ago)
• Topics: git, live-coding, presentation-slides
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/git-slide-deck
• Size: 78.1 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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       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](CONTRIBUTING.md)