commit 46741bae238f56d16071462b8dab20f1c36c1691
parent 4d8b898142ab9d9bba7c04666d8d169faeefe8ef
Author: Andrew Alderwick <andrew@alderwick.co.uk>
Date: Sun, 16 May 2021 09:39:40 +0100
Added documentation for Asma helper script
Diffstat:
2 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/etc/asma.lua b/etc/asma.lua
@@ -1,8 +1,3 @@
-local band, bor, lshift, rshift
-do
- local _obj_0 = require('bit')
- band, bor, lshift, rshift = _obj_0.band, _obj_0.bor, _obj_0.lshift, _obj_0.rshift
-end
local spairs
spairs = function(t)
local keys
diff --git a/etc/asma.moon b/etc/asma.moon
@@ -1,4 +1,22 @@
-import band, bor, lshift, rshift from require 'bit'
+--
+-- Asma tree helper script
+--
+-- This script updates the trees at the end of projects/software/asma.usm when
+-- Uxn's opcode set changes or new runes (first character of tokens) are
+-- created, so that new changes in the C assembler can be incorporated rapidly
+-- into asma.
+--
+-- To run, you need Lua or LuaJIT, and just run etc/asma.lua from the top
+-- directory of Uxn's git repository:
+--
+-- lua etc/asma.lua
+--
+-- This file is written in MoonScript, which is a language that compiles to
+-- Lua, the same way as e.g. CoffeeScript compiles to JavaScript. Since
+-- installing MoonScript has more dependencies than Lua, the compiled
+-- etc/asma.lua is kept in Uxn's repository and will be kept updated as this
+-- file changes.
+--
spairs = (t) ->
keys = [ k for k in pairs t ]
