1shlide(1) ["Version 1.0"]
  2
  3# NAME
  4
  5shlide - a slide deck presentation tool written in pure bash
  6
  7# SYNOPSIS
  8
  9shlide _deck-directory/_
 10
 11# DESCRIPTION 
 12
 13Create a directory for your slides. Name each slide starting with
 14a number and a hyphen, like so:
 15
 16	$ mkdir deck++
 17$ touch deck/1-first-slide.txt++
 18$ touch deck/2-another.txt
 19
 20*Note*: Make sure to prefix the first 9 slides with a *0* (e.g. 01-foo.txt, 02-bar.txt ...), if you have more than 10 slides.
 21
 22Finally, run:
 23
 24	$ shlide deck/
 25
 26# CONTROLS
 27
 28Next slide:
 29	*j*, *n*, *;*, *space*, *enter*
 30
 31Previous slide:
 32	*k*, *p*, *,*, *backspace*
 33
 34Jump to first slide:
 35	*0*
 36
 37Jump to last slide:
 38	*G*
 39
 40Reload:
 41	*r*
 42
 43Quit:
 44	*q*
 45
 46# FORMATTING
 47
 48Slide content can be formatted like so:
 49
 50Welcome to ${GRN}shlide${RST}. ${STR}Here${RST} are a few bullet points:
 51
 52\- first point++
 53\- second point++
 54	\* ${ITA}sub point${RST}++
 55	\* ${BLD}another${RST} sub point
 56
 57*Note*: Make sure to add ${RST} (reset) at the end.
 58
 59A full list of formatting options are below:
 60
 61## Colors
 62
 63[[ *Key*
 64:- *Effect*
 65|- BLK
 66:- black
 67|- RED
 68:- red
 69|- GRN
 70:- green
 71|- YLW
 72:- yellow
 73|- BLU
 74:- blue
 75|- PUR
 76:- purple
 77|- CYN
 78:- cyan
 79|- RST
 80:- reset
 81
 82## Styles
 83
 84[[ *Key*
 85:- *Effect*
 86|- BLD
 87:- bold
 88|- DIM
 89:- dim
 90|- ITA
 91:- italics
 92|- UND
 93:- underline
 94|- FLS
 95:- flashing
 96|- REV
 97:- reverse
 98|- INV
 99:- invert
100|- STR
101:- strikethrough
102
103# LICENSES
104
105shlide is licensed under the MIT license.