From 1f4cf161a539b24bc4e45ab5e49e4bc7101ece35 Mon Sep 17 00:00:00 2001 From: Ronan Collobert Date: Sun, 20 Oct 2013 19:23:09 +0200 Subject: Create README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..44089f2 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +sundown-ffi +=========== + +A LuaJIT interface to the Sundown library (a Markdown implementation) + +# Installation # + +torch-rocks install https://raw.github.com/andresy/sundown-ffi/master/rocks/sundown-scm-1.rockspec + +# Usage # + +```lua +local sundown = require 'sundown' + +local html = sundow.render[[ +sundown-ffi +=========== + +A LuaJIT interface to the Sundown library (a Markdown implementation) + +# Installation # + +torch-rocks install https://raw.github.com/andresy/sundown-ffi/master/rocks/sundown-scm-1.rockspec +]] +``` + +# Advanced usage # + +All functions from the library `sundown` and `houdini` are accessible through `sundown.C.func` where `func` +is the function of interest. + +See the [Sundown library page](https://github.com/vmg/sundown) for more details. + +Note that Houdini C function and structure names are prefixed here with `sdhtml_` (e.g. `sdhtml_renderer`). +Sundown C function and structure names are prefixed with `sd_` (e.g. `sd_markdown_render`). + +See sdcdefs.lua and htmlcdefs.lua for what is actually available. -- cgit v1.2.3