1# shlide
 2> a slide deck presentation tool written in pure bash
 3
 4![scrot](https://u.peppe.rs/k7.png)
 5
 6## Features
 7
 8- All slides are plain-text files. 
 9- Navigation using `j` / `k`, `n` / `p` and `space` / `enter` (only forward).
10- Text color and style formatting. 
11- Pure bash.
12
13## Requirements
14
15- `bash 4+`
16
17## Usage
18
19Create a directory for your slides. Name each slide starting with
20a number and a hyphen, like so:
21
22```shell
23$ mkdir deck
24$ touch deck/1-first-slide.txt
25$ touch deck/2-another.txt
26
27# so on
28```
29
30**Note**: Make sure to prefix the first 9 slides with a `0` (`01-foo.txt`, `02-bar.txt` ...),
31if you have more than 10 slides.
32
33Finally, run:
34
35```shell
36$ shlide deck/
37```
38
39## Formatting
40
41Slide content can be formatted like so:
42
43```txt
44Welcome to ${GRN}shlide${RST}. ${STR}Here${RST} are a few bullet points:
45
46- first point
47- second point
48    * ${ITA}sub point${RST}
49    * ${BLD}another${RST} sub point
50```
51
52**Note**: Make sure to `${RST}` (reset) at the end.
53
54A full list of formatting options are below:
55
56### Colors
57
58|Key|Effect |
59|-|-|
60| `BLK` | black |
61| `RED` | red |
62| `GRN` | green |
63| `YLW` | yellow |
64| `BLU` | blue |
65| `PUR` | purple |
66| `CYN` | cyan |
67| `RST` | reset |
68
69### Styles
70
71|Key|Effect |
72|-|-|
73| `BLD` | bold |
74| `DIM` | dim |
75| `ITA` | italics |
76| `UND` | underline  |
77| `FLS` | flashing |
78| `REV` | reverse |
79| `INV` | invert |
80| `STR` | strikethrough |
81