aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authordx <aryadevchavali1@gmail.com>2020-05-22 21:14:40 +0100
committerdx <aryadevchavali1@gmail.com>2020-05-22 21:14:40 +0100
commitb363c018c5e1af140563a82ae0bcada3b9a60910 (patch)
treecca685226082c8d712facc3cd2d3cbb9d6ca6814 /README.org
parent9cec869268461cb7cb2d7a94637e2f2e2c3ee901 (diff)
downloadmdhtml-b363c018c5e1af140563a82ae0bcada3b9a60910.tar.gz
mdhtml-b363c018c5e1af140563a82ae0bcada3b9a60910.tar.bz2
mdhtml-b363c018c5e1af140563a82ae0bcada3b9a60910.zip
~updated readme.org
Diffstat (limited to 'README.org')
-rw-r--r--README.org20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.org b/README.org
index 0ba3353..f9f6aef 100644
--- a/README.org
+++ b/README.org
@@ -1,18 +1,18 @@
* MdHtml
-Markdown to HTML converter in Python and C.
+Markdown to HTML converter in 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.
+A fun task to try out, especially in C. I'm considering this project as a kind
+of pre-compiler stage task. I do actually require a markdown to HTML converter
+for my website, and instead of installing pandoc or something, I could try and
+make 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.
+
+The /Converter/ project is the main source directory for my C implementation.
+Currently, it's capable of converting simple markdown documents though it is not
+capable of generating documents via templates. It's a bit of a mess, which I'll
+start documenting over the next few days.