# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1679995625 -7200
# Node ID d8e2b995f9759c21fd87253dbfbba04123f80a54
# Parent  5883e78b6165a5af64aa92859e41d8d540e7c11d
teal-src: Add a README with a few pointers to get started

diff -r 5883e78b6165 -r d8e2b995f975 teal-src/README.md
--- /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.
+