From d4843ea375360f37e965709e73c0fbd68e302dca Mon Sep 17 00:00:00 2001 From: =?utf8?q?Michael=20G=C3=B6hler?= Date: Sun, 14 Sep 2014 15:29:41 +0200 Subject: [PATCH] small readme changes --- Makefile | 2 +- README.md | 19 ++++++++++++++----- cstack.c | 2 +- cstring.c | 2 +- include/bitops.h | 2 +- include/cstack.h | 4 ++-- include/cstring.h | 2 +- include/markdown.h | 2 +- include/mdp.h | 2 +- include/parser.h | 2 +- include/viewer.h | 2 +- markdown.c | 2 +- mdp.c | 2 +- parser.c | 2 +- sample.md | 2 +- viewer.c | 2 +- 16 files changed, 30 insertions(+), 21 deletions(-) diff --git a/Makefile b/Makefile index 7c0cbe7..d4df0d5 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ # Makefile # Copyright (C) 2014 Michael Goehler # -# This file is part of mpd. +# This file is part of mdp. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by diff --git a/README.md b/README.md index c4a6f2b..ce9da7d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -## mpd - A command-line based markdown presentation tool. +## mdp - A command-line based markdown presentation tool. + +![image](https://cloud.githubusercontent.com/assets/2237222/4264047/62cc07b8-3c12-11e4-8710-f2e5959200c8.png) --- @@ -17,17 +19,24 @@ _Horizontal rulers are used as slide separator._ -_Supports basic markdown formatting:_ +_Supports basic markdown formating:_ -- line wide formatting +- line wide formating - headlines - code - quotes -- in-line formatting +- in-line formating - bold text - underlined text +_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._ + --- *Controls:* @@ -36,6 +45,6 @@ _Supports basic markdown formatting:_ Space, Enter, Backspace - next/previous slide - Home - go to first slide - End - go to last slide -- 0-9 - go to slide n +- 1-9 - go to slide n - q - exit diff --git a/cstack.c b/cstack.c index 2db539f..f56ee2c 100644 --- a/cstack.c +++ b/cstack.c @@ -2,7 +2,7 @@ * An implementation of a char stack in heap memory. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/cstring.c b/cstring.c index f7ea0a9..3eed860 100644 --- a/cstring.c +++ b/cstring.c @@ -2,7 +2,7 @@ * An implementation of expandable c strings in heap memory. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/include/bitops.h b/include/bitops.h index 4e4cb62..df24067 100644 --- a/include/bitops.h +++ b/include/bitops.h @@ -5,7 +5,7 @@ * Macros to do bit operations on integer variables. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/include/cstack.h b/include/cstack.h index c5005ad..bea73a6 100644 --- a/include/cstack.h +++ b/include/cstack.h @@ -5,7 +5,7 @@ * An implementation of a char stack in heap memory. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -57,4 +57,4 @@ int cstack_top(cstack_t *self, char c); int cstack_empty(cstack_t *self); void cstack_delete(cstack_t *self); -#endif // !defined( CSTACK_H ) \ No newline at end of file +#endif // !defined( CSTACK_H ) diff --git a/include/cstring.h b/include/cstring.h index ec028f3..631c7e3 100644 --- a/include/cstring.h +++ b/include/cstring.h @@ -5,7 +5,7 @@ * An implementation of expandable c strings in heap memory. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/include/markdown.h b/include/markdown.h index 1213ac7..7c786ef 100644 --- a/include/markdown.h +++ b/include/markdown.h @@ -5,7 +5,7 @@ * An implementation of markdown objects. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/include/mdp.h b/include/mdp.h index 5fe8c34..f57920b 100644 --- a/include/mdp.h +++ b/include/mdp.h @@ -2,7 +2,7 @@ #define MDP_H /* - * mpd -- A command-line based markdown presentation tool. + * mdp -- A command-line based markdown presentation tool. * Copyright (C) 2014 Michael Goehler * * This program is free software: you can redistribute it and/or modify diff --git a/include/parser.h b/include/parser.h index 9c11b2a..2690b20 100644 --- a/include/parser.h +++ b/include/parser.h @@ -7,7 +7,7 @@ * rules. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/include/viewer.h b/include/viewer.h index e8e8fcb..e368615 100644 --- a/include/viewer.h +++ b/include/viewer.h @@ -7,7 +7,7 @@ * faded in 256 color mode. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/markdown.c b/markdown.c index d0e18d6..45c4940 100644 --- a/markdown.c +++ b/markdown.c @@ -2,7 +2,7 @@ * An implementation of markdown objects. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/mdp.c b/mdp.c index d641faa..9a71cd0 100644 --- a/mdp.c +++ b/mdp.c @@ -1,5 +1,5 @@ /* - * mpd -- A command-line based markdown presentation tool. + * mdp -- A command-line based markdown presentation tool. * Copyright (C) 2014 Michael Goehler * * This program is free software: you can redistribute it and/or modify diff --git a/parser.c b/parser.c index 3474cfd..dc2677d 100644 --- a/parser.c +++ b/parser.c @@ -4,7 +4,7 @@ * rules. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/sample.md b/sample.md index 547e2b5..53afc65 100644 --- a/sample.md +++ b/sample.md @@ -2,7 +2,7 @@ %author: Michael Göhler %date: 2014-09-14 -mpd +mdp === A command-line based presentation tool. diff --git a/viewer.c b/viewer.c index 5494670..cede301 100644 --- a/viewer.c +++ b/viewer.c @@ -4,7 +4,7 @@ * faded in 256 color mode. * Copyright (C) 2014 Michael Goehler * - * This file is part of mpd. + * This file is part of mdp. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by -- 2.20.1