instructions for running
@@ -18,6 +18,12 @@ For more information, please see the [reference manual](https://github.com/titan
3. [inspect](https://github.com/kikito/inspect.lua) >= 3.1.0
4. [argparse](https://github.com/mpeterv/argparse) >= 0.5.0
+# Requirements for running Titan code
+
+You need to build the Lua interpreter in the `lua` folder, and **must** run
+any Titan code through it, otherwise the code will not see the internal functions
+and other data that it needs from Lua.
+
# Install
Titan must be installed in a standard location;
@@ -30,6 +36,10 @@ Titan must be installed in a standard location;
$ titanc [options] <input>
+If everything is all right with your `.titan` program this will generate an `.so`
+file that you can `require` from Lua. You can call from Lua any functions that
+you have defined.
+
# Compiler options
--print-ast Print the AST.
