From 6c7760385b32c093e88cdc49f889446db4a9a856 Mon Sep 17 00:00:00 2001 From: dx Date: Sat, 9 May 2020 23:36:09 +0100 Subject: +better explanation for reamde --- README.org | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index af71180..0ba3353 100644 --- a/README.org +++ b/README.org @@ -1,2 +1,18 @@ * MdHtml -Markdown to HTML converter in Python, and hopefully C. +Markdown to HTML converter in Python and C. +* Why? +A fun task to try and grapple with, especially in C as a kind of pre-compiler +stage project (similar to precalc in Math classes). +I do actually require a markdown to HTML converter for my website, and instead +of loading and installing a very large and mostly obsolete package just for this +task I think I could try making my own. +* Structure +/converter.py/ is the file where I write templating code to think out what +features I want. It's good to use, not necessarily the fastest or cleanest but +it gets the job done. Most importantly, it's a minimum working product for use +straight away. + +The /Converter/ cmake project is my C implementation of this transpiler system. +It uses a lot of techniques that I have learned from the dragon book, and I'm +kinda using it as an exercise in lexers and simple tokenizers, compiling content +from one format to another. -- cgit v1.2.3-13-gbd6f