From 6a328bf6617966ec88be7c7dd78e160933f84a94 Mon Sep 17 00:00:00 2001 From: Daniel Liu Date: Wed, 16 Jun 2021 13:03:07 -0400 Subject: [PATCH] rebranded --- .gdbinit | 1 - .gitignore | 15 ----------- CREDITS | 3 +++ Makefile | 4 +-- README.md | 64 +++++++++++++++------------------------------ mdp.cygport | 34 ------------------------ mdp.sublime-project | 35 ------------------------- mdp.1 => smdp.1 | 29 +++++++++++--------- 8 files changed, 43 insertions(+), 142 deletions(-) delete mode 100644 .gdbinit delete mode 100644 .gitignore delete mode 100644 mdp.cygport delete mode 100644 mdp.sublime-project rename mdp.1 => smdp.1 (92%) diff --git a/.gdbinit b/.gdbinit deleted file mode 100644 index 9733b15..0000000 --- a/.gdbinit +++ /dev/null @@ -1 +0,0 @@ -set args -d sample.md diff --git a/.gitignore b/.gitignore deleted file mode 100644 index b94efee..0000000 --- a/.gitignore +++ /dev/null @@ -1,15 +0,0 @@ -# temporary compile results -*.o - -# Binary excutions -mdp -mdp.exe - -# Other temporary files -.DS_Store -.idea -*~ -*.swp -*.sublime-workspace -*.out -tags diff --git a/CREDITS b/CREDITS index b613273..4c912a2 100644 --- a/CREDITS +++ b/CREDITS @@ -1,5 +1,8 @@ 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 diff --git a/Makefile b/Makefile index 02ef0fc..1d47fa0 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ UNAME_S := $(shell uname -s 2>/dev/null || echo not) SOURCES = $(sort $(wildcard src/*.c)) OBJECTS = $(SOURCES:.c=.o) -TARGET = mdp +TARGET = smdp DESTDIR = PREFIX ?= /usr/local @@ -62,7 +62,7 @@ install: 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) diff --git a/README.md b/README.md index 8c09976..6e3e9f4 100644 --- a/README.md +++ b/README.md @@ -1,41 +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/5810237/797c494c-a043-11e4-9dbd-959cab4055fa.gif) +[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. @@ -59,9 +45,7 @@ Supports headers prefixed by @ symbol. Review sample.md for more details. ---- - -***Default controls:*** +### CONTROLS - h, j, k, l, Arrow keys, Space, Enter, Backspace, @@ -72,18 +56,12 @@ Review sample.md for more details. - 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 diff --git a/mdp.cygport b/mdp.cygport deleted file mode 100644 index af6da10..0000000 --- a/mdp.cygport +++ /dev/null @@ -1,34 +0,0 @@ -# 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() { :; } - diff --git a/mdp.sublime-project b/mdp.sublime-project deleted file mode 100644 index a2a86d0..0000000 --- a/mdp.sublime-project +++ /dev/null @@ -1,35 +0,0 @@ -{ - "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"] - } - ] - } - ] -} diff --git a/mdp.1 b/smdp.1 similarity index 92% rename from mdp.1 rename to smdp.1 index 01f2e7e..6abf7ac 100644 --- a/mdp.1 +++ b/smdp.1 @@ -5,24 +5,28 @@ .\" . . -.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 @@ -79,9 +83,9 @@ MDP_LIST_HEAD3=' +- ' .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 @@ -102,7 +106,7 @@ will be displayed at the moment the presentation is launched. A single .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 @@ -110,7 +114,7 @@ This enables the user to display bullet points or list items one by one (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 @@ -128,7 +132,7 @@ As well as bold text, underlined text and in-line code. .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 @@ -157,14 +161,15 @@ This key is disabled if input was read from standard input. .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 -- 2.20.1