Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

docs

  • Loading branch information...
commit e1aff50a15140f36634e65b73d01d9203aea8d51 1 parent c685a13
@tj authored
Showing with 10 additions and 6 deletions.
  1. +10 −6 Readme.md
View
16 Readme.md
@@ -5,6 +5,8 @@
this makes manuals easier to _write_, _reuse_, and
_read_.
+ ![markdown man page](http://f.cl.ly/items/2G271F3c0D3p2i2V3l3k/Screen%20Shot%202012-04-14%20at%2012.44.58%20PM.png)
+
## Usage
Usage: mad <file>
@@ -24,11 +26,13 @@
$ make uninstall
-## Example
+## About
- `mad(1)` uses madpages itself, take a look with `mad --help`.
- Parsed and piped through `less(1)` you have paging and search
- benefits of `less(1)` with the easy of writing markdown man pages
- and nice readable output.
+ I _love_ man pages, however they are annoying to write by hand,
+ and often converted from markdown documentation. Also `man` in my
+ opinion does a poor job of displaying the information, the whitespace
+ makes them difficult to read. `mad(1)` is effectively the idea, but
+ write your manuals in markdown like you would anyway, re-use them
+ in your github readmes, wikis, or use markdown to HTML conversion
+ tools.
- ![markdown man page](http://f.cl.ly/items/2G271F3c0D3p2i2V3l3k/Screen%20Shot%202012-04-14%20at%2012.44.58%20PM.png)
Please sign in to comment.
Something went wrong with that request. Please try again.