home | doc | code | discuss | license

Because learning is not the filling of a pail, but the lighting of a fire.

As a side-effect of running ./burn, the directory "$HOME/opt/lua/burn/doc" is updated with current versions of the html generated from the *.lua files in this directory.

Note that this code cannot load any X.lua file for X in ed, okay, zap, pull, push, license, help.

The system is divided into

.
./burn           # shell script with convenience functions
                 # When run, it does "cd lib", then runs there
./data/*         # example data files
./docs/*.html    # auto-generated from lib/*.lua files
./lib/*.lua      # the actual system
./tests/*ok.lua  # to test "lib/x.lua", load "tests/xOk.lua"

There is only one global.

• Loading ./lib/burn.lua will add Burn to the global enviornment. This global holds some system stuff plus whatever global config options needed by the system.
• Loading any other files should be var safe (i.e. only locals defined).

Hence the standard way to use these files is:

local Stuff=require("stuff")

There is only one global function. burn(), which creates Burn.

• The first time it is called, then burn()
  • Creates Burn.sys which is a table holding some system stuff (e.g. test cases, test case cores).
  • Adds '../tests/?.lua' to package.path.
• For all subsequent calls, burn() does not adjust the current contents of Burn.sys (which means that, e.g. we can accumulate a global count of passing/failing tests here).