jcollard/unm-hip — pull request #4 by zdevex (2013-08-29 04:08:53+00:00)
Title: Convert Documentation to Github Flavored Markdown.

Commit https://github.com/zdevex/unm-hip/commit/f2899b4ebcac308275c8641ef07471f1b6769533 generally describes what is in this pull request. There are a few error fixes before and after that.

Finished initial conversion of README.md to Git Flavored Markdown.

Major Changes :
Converted the entire document to GFM. See https://help.github.com/articles/github-flavored-markdown for more details.
Added Note that the function (.==.) has improper documentation.
Generally changed all literal Haskell code, including inline references to Types and Type classes, to use Markdown Code syntax.
Generally changed all variables that appear inline in prose to be bold, whether or not they reference literal variables in the surrounding code.
Exception : Haskell Type variables that appeared in prose were given code syntax.

Features Added :
Haskell syntax highlighting for all Haskell code blocks.
Documentation much eaiser to read in plain text format now.
Changed variable names very slightly for (<.) example for clarity, grammar unchanged.
Note : It appears the grammer changed, but that is only because when you view the original source as HTML there is a literal '<' character that the browser reads as a new HTML tag, effectively hiding part of the code.

Error Fixed :
Many formatting errors resulting from the use of literal '<' characters.
Note : '<' characters are still in this document, but when they are used in Markdown context they are automatically encoded as HTML entities by the Markdown processor in most contexts.
Fixed reference to incorrect Image for (<.) example.
Fixed several miscellaneous typos.
Fixed typo where the flipped version of (<.) is referred to as (<.) rather than (.<)
Fixed error where the documentation for makeHotImage states that the function uses the value of the input "ColorImage" to generate the result. Rather, it uses the value of the input "GrayImage". This was inferred from the type signature.
Removed duplicate image cactii.jpg. The correct image is cacti.jpg.