about summary refs log tree commit diff
path: root/tools/cheddar/README.md
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@google.com>2019-12-21T04·20+0000
committerVincent Ambo <tazjin@google.com>2019-12-21T04·54+0000
commit4681c07bde702f64d630f25ef831267cd9ac09ee (patch)
tree2505a60cc01215eca5cf35b3d8637b096ccd0096 /tools/cheddar/README.md
parent87cf3a2c6f87394a31fb449a1a3495078fef3244 (diff)
feat(tools/cheddar): Check in new syntax highlighting tool r/276
The first step with this tool will be to use it as a source-filter for
cgit. The second step is to use it as the Markdown renderer by
depending on one of the Markdown libraries, with integration for
rendering code snippets directly.
Diffstat (limited to 'tools/cheddar/README.md')
-rw-r--r--tools/cheddar/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/tools/cheddar/README.md b/tools/cheddar/README.md
new file mode 100644
index 000000000000..96faa34a4f6b
--- /dev/null
+++ b/tools/cheddar/README.md
@@ -0,0 +1,10 @@
+cheddar
+=======
+
+Cheddar is a tiny Rust tool that uses [syntect][] to render source code to
+syntax-highlighted HTML.
+
+The name was chosen because I was eyeing a pack of cheddar-flavoured crisps
+while thinking about name selection.
+
+[syntect]: https://github.com/trishume/syntect