prosody
d8e2b995f975
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 @ 13002:d8e2b995f975

teal-src: Add a README with a few pointers to get started
author Kim Alvefur <zash@zash.se>
date Tue, 28 Mar 2023 11:27:05 +0200
child 13004:47efa93ea859
comparison
equal deleted inserted replaced
13001:5883e78b6165 13002:d8e2b995f975
1 # Teal definitions and sources
2
3 This directory contains files written in the
4 [Teal](https://github.com/teal-language/tl) language, a typed dialect of
5 Lua. There are two kinds of files, `.tl` Teal source code and `.d.tl`
6 type definitions files for modules written in Lua. The later allows
7 writing type-aware Teal using regular Lua or C code.
8
9 ## Setup
10
11 The Teal compiler can be installed from LuaRocks using:
12
13 luarocks install tl
14
15 ## Checking types
16
17 ```bash
18 tl check teal-src/prosody/util/example.tl
19 ```
20
21 Some editors and IDEs also have support, see [text editor
22 support](https://github.com/teal-language/tl#text-editor-support)
23
24
25 ## Files of note
26
27 `module.d.tl`
28 : Describes the module environment.
29