diff options
| author | dx <aryadevchavali1@gmail.com> | 2020-05-09 23:36:09 +0100 |
|---|---|---|
| committer | dx <aryadevchavali1@gmail.com> | 2020-05-09 23:36:09 +0100 |
| commit | 6c7760385b32c093e88cdc49f889446db4a9a856 (patch) | |
| tree | 1831a15acdbee9a606ce5b71c81692ade6001244 /README.org | |
| parent | 953cd6edf07eeae011aa316e14cd7d1757afdedd (diff) | |
| download | mdhtml-6c7760385b32c093e88cdc49f889446db4a9a856.tar.gz mdhtml-6c7760385b32c093e88cdc49f889446db4a9a856.tar.bz2 mdhtml-6c7760385b32c093e88cdc49f889446db4a9a856.zip | |
+better explanation for reamde
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -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. |