X-Git-Url: https://git.danieliu.xyz/?p=smdp.git;a=blobdiff_plain;f=README.md;h=cbedfd8b5ef71f0346c88d89bc5ab69304bf086c;hp=e6cf4a97c387cfc1da1740cc84279a2de4e3b715;hb=HEAD;hpb=3998921f3dd1b86f8db11d45f8a6edb5231f1f00

diff --git a/README.md b/README.md
index e6cf4a9..cbedfd8 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,27 @@
 
-## mdp - A command-line based markdown presentation tool.
+## smdp - A suckless command-line based markdown presentation tool
 
-![image](https://cloud.githubusercontent.com/assets/2237222/4280231/d63178fa-3d2a-11e4-88a6-2b8e3608c4ca.gif)
+[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
 
-mdp needs the ncursesw headers to compile.
-So make sure you have them installed:
-- on Ubuntu/Debian you need `libncursesw5` and `libncursesw5-dev`
-- on Cygwin you need `libncursesw10` and `libncurses-devel`
+**smdp** needs the ncursesw headers to compile. Install based on your distro, and compile using:
 
-Now download and install mdp:
+```
+git clone https://github.com/MrPicklePinosaur/smdp.git
+cd smdp
+make
+make install
+smdp sample.md
+```
 
-    $ git clone https://github.com/visit1985/mdp.git
-    $ cd mdp
-    $ make
-    $ make install
-    $ mdp sample.md
-
-- On Arch you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/).
-- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`
-- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
-
-Most terminals support 256 colors only if the TERM variable is
-set correctly. To enjoy mdp's color fading feature:
-
-    $ export TERM=xterm-256color
-
----
-
-***How to use it:***
+### USAGE
 
 Horizontal rulers are used as slide separator.
 
@@ -55,24 +45,23 @@ Supports headers prefixed by @ symbol.
 
 Review sample.md for more details.
 
----
-
-***Controls:***
+### CONTROLS
 
-- h, j, k, l, Cursor keys,
+- h, j, k, l, Arrow keys,
     Space, Enter, Backspace,
     Page Up, Page Down - next/previous slide
-- Home - go to first slide
-- End - go to last 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
 
----
-
-***How to debug it:***
+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.
 
-To make a debug version of `mdp`, just type:
+### CREDITS
 
-    $ make DEBUG=1
+Many kudos to the original authors and contributors of **mdp**. Once again, you can find the original project [here](https://github.com/visit1985/mdp).