prosody
1167aaf1aa1f
teal-src/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

teal-src/README.md @ 13005:1167aaf1aa1f

teal-src/README: Words on Compiling to Lua
author Kim Alvefur <zash@zash.se>
date Tue, 28 Mar 2023 11:42:20 +0200
parent 13004:47efa93ea859
comparison
equal deleted inserted replaced
13004:47efa93ea859 13005:1167aaf1aa1f
22 22
23 Some editors and IDEs also have support, see [text editor 23 Some editors and IDEs also have support, see [text editor
24 support](https://github.com/teal-language/tl#text-editor-support) 24 support](https://github.com/teal-language/tl#text-editor-support)
25 25
26 26
27 ## Compiling to Lua
28
29 `GNUmakefile` contains a rule for building Lua files from Teal sources.
30 It also applies [LuaFormat](https://github.com/Koihik/LuaFormatter) to
31 make the resulting code more readable, albeit this makes the line
32 numbers no longer match the original Teal source. Sometimes minor
33 `luacheck` issues remain, such as types being represented as unused
34 tables, which can be removed.
35
36 ```bash
37 sensible-editor teal-src/prosody/util/example.tl
38 # Write some code, remember to run tl check
39 make util/example.lua
40 sensible-editor util/example.lua
41 # Apply any minor tweaks that may be needed
42 ```
43
27 ## Files of note 44 ## Files of note
28 45
29 `module.d.tl` 46 `module.d.tl`
30 : Describes the module environment. 47 : Describes the module environment.
31 48