README.md

   1
   2 ## smdp - A suckless command-line based markdown presentation tool
   3
   4 [NEW GIF COMING SOON]
   5
   6 ### BACKGROUND
   7 **smdp** is a fork of **mdp** (find it [here](https://github.com/visit1985/mdp), the wonderful markdown presentation program. **smdp** is a set of modifications to my liking, namely, to make the project more suckless. Here's some notable differences:
   8 - configuration variables were abstracted out into a config.h variable (you can now change colors and keybindings to your liking!)
   9 - color fading and transparency was removed
  10 - patches are encouraged (i will be providing a couple myself)
  11
  12 ### INSTALLATION
  13
  14 **smdp** needs the ncursesw headers to compile. Install based on your distro, and compile using:
  15
  16 ```
  17 git clone https://github.com/MrPicklePinosaur/smdp.git
  18 cd smdp
  19 make
  20 make install
  21 smdp sample.md
  22 ```
  23
  24 ### USAGE
  25
  26 Horizontal rulers are used as slide separator.
  27
  28 Supports basic markdown formating:
  29
  30 - line wide markup
  31     - headlines
  32     - code
  33     - quotes
  34     - unordered list
  35
  36 - in-line markup
  37     - bold text
  38     - underlined text
  39     - code
  40
  41 Supports headers prefixed by @ symbol.
  42
  43 - first two header lines are displayed as title and author
  44     in top and bottom bar
  45
  46 Review sample.md for more details.
  47
  48 ### CONTROLS
  49
  50 - h, j, k, l, Arrow keys,
  51     Space, Enter, Backspace,
  52     Page Up, Page Down - next/previous slide
  53 - Home, g - go to first slide
  54 - End, G - go to last slide
  55 - 1-9 - go to slide n
  56 - r - reload input file
  57 - q - exit
  58
  59 ### CONFIGURATION
  60
  61 A `config.h` configuration file is available in `include/`, change the settings you want and recompile.
  62 Colors, keybindings and list types are configurable as of now. Note that configuring colors only works in 8 color mode.
  63
  64 ### CREDITS
  65
  66 Many kudos to the original authors and contributors of **mdp**. Once again, you can find the original project [here](https://github.com/visit1985/mdp).
  67