Project

tty_slides

0.0
No commit activity in last 3 years
No release in over 3 years
tty_slidesdapplebeforedawn/tty_slidesHomepageDocumentationSource CodeBug TrackerWiki
Do a presentation from the terminal.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
8,499
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.0.3
Total releases
3
First release
2014-02-02
Latest release
2014-02-02
 Development
Primary Language
Ruby
Average date of last 50 commits
2013-12-21
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0

Runtime

nokogiri
>= 0
 Project Readme

TTY Slides

Gem for presenting slides with the terminal

Screenshots

screenshot1 screenshot2 screenshot3

Installation

gem install tty_slides

Usage

Create a startup file (e.g. start.rb)

#! /usr/bin/env ruby

require "tty_slides"

# define the BASE_PATH and SLIDES
class TtySlides::SlideList
  BASE_PATH = Pathname.new(__FILE__) + ".." + "slides"

  SLIDES = [
    "introduction"
  ]
end

# call `#start`
TtySlides.new('[ My Presentation ]').start

Start the presentation: ``bash bundle exec ruby start.rb


## Adding Slides
Slides are stored in bastardized version of HTML that can be rendred with n-curses.  They are found in the `doc/` folder
### CML specification
  - `<head>`: the text node in this element is positioned at the top left of the screen.
  - `<body>`: contains any number of `<div>`, `<span>`, `<code>` or `<line>` tags.
  - `<div>` and `<span>`: go togeather to make a vertially and horizontally centered line.  Each div can be no longer than one line.
  - `<code>` and `<line>`: go togeather to make left aligned text that is in a horizontally and vertically centered box.  Each line, should be one line.  Duh.
  - attributes must be curses attribute calls e.g.
  `Curses.color_pair(RED_COLOR)` becomes `color_pair(RED_COLOR)`

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request