all repos — hastyscribe @ 1b4bf498d10a3c0dfebe7a69301b5f2b1ead3444

A professional markdown compiler.

Added README
h3rald h3rald@h3rald.com
Sat, 12 Oct 2013 21:51:28 +0200
commit

1b4bf498d10a3c0dfebe7a69301b5f2b1ead3444

parent

9b0f15e595cb16070d5ed2dee05abda933ca3da9

2 files changed, 67 insertions(+), 2 deletions(-)

jump to
M .gitignore.gitignore

@@ -1,2 +1,4 @@

nimcache/ +build/ libmarkdown.a +README.htm
M README.mdREADME.md

@@ -1,2 +1,65 @@

-hastyscribe -=========== +# HastyScribe + +_HastyScribe_ is a simple command-line program able to convert [markdown](http://daringfireball.net/projects/markdown) files into HTML files. + +## Usage + +**hastyscribe** _filename.md_ [ **\--notoc** ] + + +## FAQs + +### Why is _HastyScribe_ different from other markdown converters? + +Because: + +* It is a cross-platform, self-contained executable file +* It comes with its own stylesheet, which is automatically embedded into every HTML document +* It is built on top of [Discount](http://www.pell.portland.or.us/~orc/Code/discount/), which means that besides standard markdown you also get: + * strikethrough + * automatic Table of Contents generation + * [SmartyPants](http://daringfireball.net/projects/smartypants/) substitutions + * paragraph centering + * image sizes + * definition lists + * alphabetic lists + * pseudo-protocols to generate `span` tags with arbitrary CSS classes, `abbr` tags, and anchors + * class blocks + * tables + * fenced code blocks + * [Pandoc](http://johnmacfarlane.net/pandoc/)-style docuemnt headers + +### What can I use it for? + +_HastyScribe_ is best suited to produce standalone, mainly-textual documents such as meeting notes, project status documents, and articles. + +### What language is _HastyScribe_ implemented in? + +HastyScribe is implemented in [Nimrod][nimrod], a very expressive language that compiles to C and is able to generate small, standalone and self-contained executable files. + +### How do I build _HastyScribe_ from source? + + +First of all you need a **libmarkdown.a** static library. You can either grab one precompiled (for Windows x64 or OSX x64) from the [vendor](https://github.com/h3rald/hastyscribe/blob/master/vendor) or build your own. + +If you choose to build your own: + +1. Download/clone [Discount](https://github.com/Orc/discount) source code +2. In the directory containing Discount source code, run the following commands: + + <tt>./configure.sh --with-tabstops=2 --with-dl=both --with-id-anchor --with-github-tags --with-fenced-code --enable-all-features</tt> + + <tt>make</tt> + + Note: If you are on Windows, you can compile it using [MinGW](http://www.mingw.org/). + +Once you have a **libmarkdown.a** static library for your platform: + +1. Download and install [Nimrod][nimrod]. On OSX you can also <tt>brew install nimrod</tt> if you have [HomeBrew](http://brew.sh/) installed. +2. Download/clone HastyScribe. +3. Put your **libmarkdown.a** file in the **vendor** directory. +4. Run **osxbuild** (if you are on OSX) or **winbuild.bat** (if you are on windows) or the following: + + <tt>nimrod --clibdir:vendor --clib:markdown c hastyscribe.nim</tt> + +[nimrod]: http://nimrod-code.org/