-## mdp - A command-line based markdown presentation tool.
+## smdp - A suckless command-line based markdown presentation tool
-
+[NEW GIF COMING SOON]
----
+### BACKGROUND
+**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:
+- configuration variables were abstracted out into a config.h variable (you can now change colors and keybindings to your liking!)
+- color fading and transparency was removed
+- patches are encouraged (i will be providing a couple myself)
-*How to get started:*
+### INSTALLATION
- $ git clone https://github.com/visit1985/mdp.git
- $ cd mdp
- $ make
- $ make install
- $ mdp sample.md
+**smdp** needs the ncursesw headers to compile. Install based on your distro, and compile using:
----
+```
+git clone https://github.com/MrPicklePinosaur/smdp.git
+cd smdp
+make
+make install
+smdp sample.md
+```
-*How to use it:*
+### USAGE
-_Horizontal rulers are used as slide separator._
+Horizontal rulers are used as slide separator.
-_Supports basic markdown formating:_
+Supports basic markdown formating:
-- line wide formating
+- line wide markup
- headlines
- code
- quotes
+ - unordered list
-- in-line formating
+- in-line markup
- bold text
- underlined text
+ - code
-_Supports headers prefixed by @ symbol._
+Supports headers prefixed by @ symbol.
- first two header lines are displayed as title and author
- in top and bottom bar
-
-_Review sample.md for more details._
+ in top and bottom bar
----
+Review sample.md for more details.
-*Controls:*
+### CONTROLS
-- h, j, k, l, Cursor keys,
- Space, Enter, Backspace - next/previous slide
-- Home - go to first slide
-- End - go to last slide
+- h, j, k, l, Arrow keys,
+ Space, Enter, Backspace,
+ Page Up, Page Down - next/previous slide
+- Home, g - go to first slide
+- End, G - go to last slide
- 1-9 - go to slide n
+- r - reload input file
- q - exit
+### CONFIGURATION
+
+A `config.h` configuration file is available in `include/`, change the settings you want and recompile.
+Colors, keybindings and list types are configurable as of now. Note that configuring colors only works in 8 color mode.
+
+### CREDITS
+
+Many kudos to the original authors and contributors of **mdp**. Once again, you can find the original project [here](https://github.com/visit1985/mdp).
+
