+++ /dev/null
-set args -d sample.md
+++ /dev/null
-# temporary compile results
-*.o
-
-# Binary excutions
-mdp
-mdp.exe
-
-# Other temporary files
-.DS_Store
-.idea
-*~
-*.swp
-*.sublime-workspace
-*.out
-tags
Credits go to
+Michael Goehler for original mdp project
+https://github.com/visit1985/mdp
+
Joshua M. Clulow for his terminal-based presentation tool in node.js
https://github.com/jclulow/vtmc
SOURCES = $(sort $(wildcard src/*.c))
OBJECTS = $(SOURCES:.c=.o)
-TARGET = mdp
+TARGET = smdp
DESTDIR =
PREFIX ?= /usr/local
install -d $(DESTDIR)$(PREFIX)/bin
install -m 755 $(TARGET) $(DESTDIR)$(PREFIX)/bin/$(TARGET)
install -d $(DESTDIR)$(PREFIX)/share/man/man1
- install -m 644 mdp.1 $(DESTDIR)$(PREFIX)/share/man/man1/$(TARGET).1
+ install -m 644 smdp.1 $(DESTDIR)$(PREFIX)/share/man/man1/$(TARGET).1
uninstall:
$(RM) $(DESTDIR)$(PREFIX)/bin/$(TARGET)
-## 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](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:
+**smdp** needs the ncursesw headers to compile. Install based on your distro, and compile using:
-- on Raspbian (Raspberry Pi) you need `libncurses5-dev` and `libncursesw5-dev`
+```
+git clone https://github.com/MrPicklePinosaur/smdp.git
+cd smdp
+make
+make install
+smdp sample.md
+```
-Now download and install mdp:
-
- $ git clone https://github.com/visit1985/mdp.git
- $ cd mdp
- $ make
- $ make install
- $ mdp sample.md
-
-- On Arch Linux, you can use the existing [package](https://www.archlinux.org/packages/community/x86_64/mdp/).
-- on Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program.
-- On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`.
-- On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp).
-- On OS-X, use the existing [Homebrew Formula](http://brewformulas.org/Mdp) by running `brew install mdp`.
-- On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run `sbopkg -i mdp`.
-- On Ubuntu, you can use the existing [DEB package](https://launchpad.net/ubuntu/+source/mdp-src), or run `apt-get install mdp`.
-
-Most terminals support 256 colors only if the TERM variable is
-set correctly:
-
- $ export TERM=xterm-256color
-
----
-
-***How to use it:***
+### USAGE
Horizontal rulers are used as slide separator.
Review sample.md for more details.
----
-
-***Default controls:***
+### CONTROLS
- h, j, k, l, Arrow keys,
Space, Enter, Backspace,
- r - reload input file
- q - exit
-
----
-
-***Configuration***:
+### 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.
----
-
-***How to debug it:***
+### CREDITS
-To make a debug version of `mdp`, just type:
+Many kudos to the original authors and contributors of **mdp**. Once again, you can find the original project [here](https://github.com/visit1985/mdp).
- $ make DEBUG=1
+++ /dev/null
-# package name
-NAME="mdp"
-VERSION=1.0.9
-RELEASE=1
-
-# .hint generation
-CATEGORY="Utils"
-SUMMARY="A command-line based markdown presentation tool"
-DESCRIPTION="A ncurses-based command-line presentation tool, which makes
-it easy to create slides using the popular markdown format."
-
-# source and patch files
-SRC_URI="https://github.com/visit1985/mdp/archive/${VERSION}.tar.gz"
-DOCS="sample.md"
-
-# Build dependencies only
-DEPEND="gcc-core libncurses-devel make"
-# runtime deps to go in setup.hint
-#REQUIRES="libncursesw10"
-
-# custom src_compile, src_install and src_test
-
-src_compile() {
- cd ${S}
- cygmake
-}
-
-src_install() {
- cd ${S}
- PREFIX=/usr cyginstall
-}
-
-src_test() { :; }
-
+++ /dev/null
-{
- "settings":
- {
- "tab_size": 4,
- "translate_tabs_to_spaces": true,
- "use_tab_stops": false
- }
- ,"folders":
- [
- {
- "follow_symlinks": true,
- "path": ".",
- "file_exclude_patterns": [".*", "mdp", "mdp.sublime-project", "mdp.sublime-workspace"]
- }
- ]
- ,"build_systems":
- [
- {
- "name": "mdp",
- "env": {
- "DEBUG": "1"
- },
- "cmd": ["make"],
- "working_dir": "${project_path:${folder}}",
-
- "variants":
- [
- {
- "name": "Clean",
- "cmd": ["make", "clean"]
- }
- ]
- }
- ]
-}
.\"
.
.
-.TH MDP 1 "2016-04-02" "User Commands"
+.TH SMDP 1 "2016-04-02" "User Commands"
.SH NAME
-mdp \- A command-line based
+smdp \- A suckless command-line based
markdown presentation tool
.SH SYNOPSIS
-.B mdp
+.B smdp
.RI [ OPTION ].\|.\|.\|
.RI [ FILE ]
.
.SH DESCRIPTION
-.B mdp
+.B smdp
is a command-line program that allows you to make elegant presentations from
.B markdown formatted
.IR FILE s.
.PP
It is as easy as write your presentation content in the text editor of your
preference and launch the presentation from the command-line.
-.
+.B smdp
+is a fork of
+.B mdp
+aimed to be more configurable and simple, please check out the original project too!
+
.SH OPTIONS
.SS "Input Control"
.TP
.SH MARKDOWN FORMATTING
For a complete list of supported markups, refer the sample presentation
(sample.md) provided alongside
-.BR mdp ,\|
+.BR smdp ,\|
or online available at
-.IR https://github.com/visit1985/mdp .
+.IR https://github.com/MrPicklePinosaur/smdp .
.SS "Slides"
The input
.IR FILE
A single
.BR "<br>" ", " "<BR>" " or " "^"
on an otherwise empty line signals
-.B mdp
+.B smdp
to stop output of the current slide (stop point) and wait for a key-press by
the user.
.PP
(line by line) or block by block.
.
.SS "Headers"
-.B mdp
+.B smdp
supports header lines in the format of
.BR @ "[DESCRIPTION] " [VALUE]
The first two header lines are displayed as title and author in top and
.SH COLOR SUPPORT
Most terminals are able to display 256 colors these days. But some of them
enable only 16 colors by default. To enjoy
-.BR mdp "'s"
+.BR smdp "'s"
full capabilities, these terminals need to be signaled to enable 256 color
mode. This is usually done by setting the TERM environment variable.
.PP
.TP
.BR "q"
Exit
-.BR mdp "."
+.BR smdp "."
.
.SH CUSTOMIZATION
-.B mdp
+.B smdp
can be configured by modifying config.h and recompiling.
.SH AUTHOR
Written by Michael Goehler and others, see
.IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
+Forked and modified by pinosaur.
.SH COPYRIGHT
Copyright (C) 2018 Michael Goehler
.PP
