Bruce/nomsu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updating documentation

Browse Source
This commit is contained in:
Bruce Hill 2019-01-16 16:46:38 -08:00
parent 75bb8979ae
commit 517d661368
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -54,6 +54,7 @@ All `.moon` files have been precompiled into corresponding `.lua` files, so you
* [nomsu\_decompiler.moon](nomsu_compiler.moon) - This file defines functions that transform Nomsu syntax trees back into Nomsu code. This can be used for auto-formatting. * [nomsu\_decompiler.moon](nomsu_compiler.moon) - This file defines functions that transform Nomsu syntax trees back into Nomsu code. This can be used for auto-formatting.
* [nomsu\_environment.moon](nomsu_environment.moon) - This file defines the environment in which Nomsu code runs, including some basic built-in functions. * [nomsu\_environment.moon](nomsu_environment.moon) - This file defines the environment in which Nomsu code runs, including some basic built-in functions.
* [bitops.moon](bitops.moon) - This is a shim for Lua 5.2 and LuaJIT that defines bitwise operations that respect metamethods. * [bitops.moon](bitops.moon) - This is a shim for Lua 5.2 and LuaJIT that defines bitwise operations that respect metamethods.
* [bootstrap.moon](bootstrap.moon) - This file defines some bootstrapping compile rules.
* [code\_obj.moon](code_obj.moon) - Datastructures used for incrementally building generated code, while preserving code source information. * [code\_obj.moon](code_obj.moon) - Datastructures used for incrementally building generated code, while preserving code source information.
* [containers.moon](containers.moon) - A library that defines some custom containers (List and Dict) used by nomsu. * [containers.moon](containers.moon) - A library that defines some custom containers (List and Dict) used by nomsu.
* [error\_handling.moon](error_handling.moon) - The logic for producing good error messages within Lua that reference the Nomsu source code that led to them. * [error\_handling.moon](error_handling.moon) - The logic for producing good error messages within Lua that reference the Nomsu source code that led to them.
@ -63,8 +64,8 @@ All `.moon` files have been precompiled into corresponding `.lua` files, so you
* [syntax\_tree.moon](syntax_tree.moon) - Datastructures used for Nomsu Abstract Syntax Trees. * [syntax\_tree.moon](syntax_tree.moon) - Datastructures used for Nomsu Abstract Syntax Trees.
* [examples/how\_do\_i.nom](examples/how_do_i.nom) - A simple walkthrough of some of the features of Nomsu, written in Nomsu code. **This is a good place to start.** * [examples/how\_do\_i.nom](examples/how_do_i.nom) - A simple walkthrough of some of the features of Nomsu, written in Nomsu code. **This is a good place to start.**
* [lib/\*/\*.nom](lib) - Language libraries, including the core language stuff like control flow, operators, and metaprogramming (in [lib/core](lib/core)) and optional language libraries for stuff you might want. * [lib/\*/\*.nom](lib) - Language libraries, including the core language stuff like control flow, operators, and metaprogramming (in [lib/core](lib/core)) and optional language libraries for stuff you might want.
* [compatibility/\*.nom](compatibility) - Code for automatically upgrading Nomsu code from old versions to the current version. * [lib/compatibility/\*.nom](compatibility) - Code for automatically upgrading Nomsu code from old versions to the current version.
* [tools/\*.nom](tools) - A set of utilities useful for doing code manipulation actions. * [lib/tools/\*.nom](tools) - A set of utilities useful for doing code manipulation actions.
* [Makefile](Makefile) - Rules for building/installing the compiler. * [Makefile](Makefile) - Rules for building/installing the compiler.
* [LICENSE](LICENSE) - The software license (MIT). * [LICENSE](LICENSE) - The software license (MIT).
* [README.md](README.md) - This file. * [README.md](README.md) - This file.

11
examples/how_do_i.nom
View File

@ -252,6 +252,17 @@ say both "Very very very very long first argument that needs its own line"
# This can be nested: # This can be nested:
say both (my favorite number) and also "foo" say both (my favorite number) and also "foo"
# Object-oriented programming:
# How do I define a class?
a (Vec) is a thing:
($its, + $other) means (Vec {.x = ($its.x + $other.x), .y = ($its.y + $other.y)})
($its, length) means
sqrt ($its.x * $its.x + $its.y * $its.y)
$v1 = (Vec {.x = 1, .y = 2})
assume ($v1 + $v1) == (Vec {.x = 2, .y = 4})
say $v1
# Macros: # Macros:
# The "lua>" and "=lua" macros can be used to write raw lua code: # The "lua>" and "=lua" macros can be used to write raw lua code:
(say the time) means: (say the time) means: