diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b40b2a9 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +This is a programming language designed to be used for playing games of Nomic, or engaging +in other similar activities revolving around natural language rule-making and self modification. + +The language compiler was written in [moonscript](http://moonscript.org/), using the +[lpeg library](http://www.inf.puc-rio.br/~roberto/lpeg/) for parsing. All of the moon files +have been compiled into lua for convenience. + +In order to run a .nom file, run `lua nomic.lua your_file.nom`. Code can also be compiled +into lua code directly, which still requires nomic.lua as a dependency, but bypasses the +compilation phase when it runs. To compile, run `lua nomic.lua your_file.nom output_file.lua` +which produces an output file which can be run with the command `lua output_file.lua`. + +Example code can be found in the examples folder. |