rjp

README.md Outline

• Header and a Brief description (should match package.json)
• Example (if applicable)
• Motivation (if applicable)
• API Documentation: This will likely vary considerably from library to library.
• Installation
• Tests
• Contributors
• License

erikh

#!/usr/bin/env sh

##
# This is script with usefull tips taken from:
#   https://github.com/mathiasbynens/dotfiles/blob/master/.osx
#
# install it:
#   curl -sL https://raw.github.com/gist/2108403/hack.sh | sh
#

lukego

sed -E -e 's/^/    /g' -e 's/^    --- ?//g' | pandoc -o listing.pdf -

That expression is a cheap literate programming system for Markdown.
Start commentary lines with '--- ' and they will be
markdown-formatted, the rest will be code. (Uses Lua comment syntax.)

Finally the right implementation of this idea:
  http://fresh.homeunix.net/~luke/misc/emacs/pbook.pdf (program)
  http://fresh.homeunix.net/~luke/misc/erlang/regtest.pdf (better example)