library-mirrors/moonscript
1
0
Fork 0
mirror of https://github.com/leafo/moonscript.git synced 2024-11-22 02:44:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme cleanup

Browse Source
This commit is contained in:
leaf corcoran 2011-07-15 20:37:52 -07:00
parent 9438b5df9b
commit 82087b44c8
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -37,7 +37,7 @@ command line, like any first-class scripting language.
## Installation ## Installation
## Installing with LuaRocks ### Installing with LuaRocks
The easiest way to install is to use Lua rocks and the provide rockspec. The easiest way to install is to use Lua rocks and the provide rockspec.
@ -59,15 +59,19 @@ If you are on Linux and want to run *watch* mode, which compiles `moon` files to
[linotify](https://github.com/hoelzro/linotify). [linotify](https://github.com/hoelzro/linotify).
# Learning ## Learning
Read the [reference manual](docs/index.md). Read the [reference manual](docs/index.md).
# Command Line Use ## Command Line Use
Two tools are installed with MoonScript, `moon` and `moonc`. Two tools are installed with MoonScript, `moon` and `moonc`.
`moonc` is used for transforming MoonsScript code into a Lua file.
It takes a list of files, compiles them all, and creates the associated `.lua`
files in the same directories.
## moon
### moon
`moon` can be used to run MoonsScript files directly from the command line, `moon` can be used to run MoonsScript files directly from the command line,
without needing a separate compile step. All MoonsScript files are compiled in without needing a separate compile step. All MoonsScript files are compiled in
@ -79,7 +83,7 @@ automatically.
In addition to this, when an error occurs during runtime, the stack trace is In addition to this, when an error occurs during runtime, the stack trace is
rewritten to give line numbers from the original `.moon` file. rewritten to give line numbers from the original `.moon` file.
## moonc ### moonc
`moonc` is used for transforming a MoonsScript file into a Lua file. `moonc` is used for transforming a MoonsScript file into a Lua file.
It takes a list of files, compiles them all, and creates the associated `.lua` It takes a list of files, compiles them all, and creates the associated `.lua`