mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-01 20:27:39 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

teal-src/README: Words on Compiling to Lua

Browse source
This commit is contained in:
Kim Alvefur 2023-03-28 11:42:20 +02:00
parent 4a78b88efd
commit 9305f47525
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
teal-src/README.md
View file

@ -24,6 +24,23 @@ Some editors and IDEs also have support, see [text editor
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`