commit 6687c8d1a95ff6c16b6a44170e3533906921f2cd
parent d689bdd2d88dc5372d89196240f8a4153a76e8cd
Author: gearsix <gearsix@tuta.io>
Date: Fri, 26 Nov 2021 15:14:53 +0000
upates to README
Diffstat:
| M | README | | | 28 | ++++++++++++++++++---------- |
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/README b/README
@@ -1,14 +1,21 @@
-txt2html
-========
-
txt2html is a tool for converting text files to HTML.
Written as a exercise in writing a simple syntax parser.
-The goal is to be simple and not to create set of syntax rules for another markup language - just to take conventions commonly found in .txt files and convert them to HTML. Which has just resulted in a subset of Markdown anyway.
+The goal is to be simple and not to create set of syntax rules for
+another markup language - just to take conventions commonly found in
+.txt files and convert them to HTML.
+Which has just resulted in a subset of Markdown anyway.
If you're looking for a good tool that does the same job, I'd recommend cmark (https://github.com/commonmark/cmark).
+**Remotes:**
+
+- [git.gearsix.net/txt2html](https://git.gearsix.net/txt2html),
+- [notabug.org/gearsix/txt2html](https://notabug.org/gearsix/txt2html),
+- [gitlab.com/gearsix/txt2html](https://gitlab.com/gearsix/txt2html)
+
+
usage
-----
@@ -35,15 +42,16 @@ The following rules from Markdown are followed:
- Unordered lists (using `*` and `-`)
- Pre blocks (only indented blocks)
-notes
------
+building
+--------
+
+Building the tool is easy, just run `make`, or `make debug` debug to include debug symbols.
-- I made a point to avoid using recursion (which is typically how ast trees are built).
-Partly as a challenge and partly because I thought I could get away without it.
-- There could probably be a fair bit of cleanup but I've been checking the tool against Valgrind (both compiled with gcc and musl) to avoid memory leaks and other issues.
+Doing it manually is easy too, there are no external dependencies, here's an example using GCC:
+`gcc -o txt2html *.c`
authors
-------
-- gearsix (gearsix@tuta.io)
+- gearsix
