# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1679996540 -7200
# Node ID 1167aaf1aa1fe9de17cb8ceac004d5d5473ec98f
# Parent  47efa93ea8595e6d3b4e1718915e781a9892a082
teal-src/README: Words on Compiling to Lua

diff -r 47efa93ea859 -r 1167aaf1aa1f teal-src/README.md
--- a/teal-src/README.md	Tue Mar 28 11:42:09 2023 +0200
+++ b/teal-src/README.md	Tue Mar 28 11:42:20 2023 +0200
@@ -24,6 +24,23 @@
 support](https://github.com/teal-language/tl#text-editor-support)
 
 
+## Compiling to Lua
+
+`GNUmakefile` contains a rule for building Lua files from Teal sources.
+It also applies [LuaFormat](https://github.com/Koihik/LuaFormatter) to
+make the resulting code more readable, albeit this makes the line
+numbers no longer match the original Teal source.  Sometimes minor
+`luacheck` issues remain, such as types being represented as unused
+tables, which can be removed.
+
+```bash
+sensible-editor teal-src/prosody/util/example.tl
+# Write some code, remember to run tl check
+make util/example.lua
+sensible-editor util/example.lua
+# Apply any minor tweaks that may be needed
+```
+
 ## Files of note
 
 `module.d.tl`