Software / code / prosody
Changeset
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 |
| parents | 13001:5883e78b6165 |
| children | 13003:34ed17ef1c1a |
| files | teal-src/README.md |
| diffstat | 1 files changed, 29 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/teal-src/README.md Tue Mar 28 11:27:05 2023 +0200 @@ -0,0 +1,29 @@ +# Teal definitions and sources + +This directory contains files written in the +[Teal](https://github.com/teal-language/tl) language, a typed dialect of +Lua. There are two kinds of files, `.tl` Teal source code and `.d.tl` +type definitions files for modules written in Lua. The later allows +writing type-aware Teal using regular Lua or C code. + +## Setup + +The Teal compiler can be installed from LuaRocks using: + + luarocks install tl + +## Checking types + +```bash +tl check teal-src/prosody/util/example.tl +``` + +Some editors and IDEs also have support, see [text editor +support](https://github.com/teal-language/tl#text-editor-support) + + +## Files of note + +`module.d.tl` +: Describes the module environment. +
