2011-07-16 03:27:28 +00:00
|
|
|
# MoonScript
|
|
|
|
|
2014-07-19 01:10:27 +00:00
|
|
|
[![MoonScript](http://leafo.net/dump/sailormoonscript.png)](http://moonscript.org)
|
|
|
|
|
2015-12-07 01:24:44 +00:00
|
|
|
[![Build Status](https://travis-ci.org/leafo/moonscript.svg?branch=master)](https://travis-ci.org/leafo/moonscript) [![Build status](https://ci.appveyor.com/api/projects/status/f5prpi4wvytul290/branch/binaries?svg=true)](https://ci.appveyor.com/project/leafo/moonscript/branch/binaries)
|
|
|
|
|
2014-07-19 01:10:27 +00:00
|
|
|
|
2011-07-16 03:27:28 +00:00
|
|
|
MoonScript is a programmer friendly language that compiles into
|
2013-01-03 01:58:55 +00:00
|
|
|
[Lua](http://www.lua.org/). It gives you the power of the fastest scripting
|
2015-02-28 20:47:21 +00:00
|
|
|
language combined with a rich set of features. It runs on Lua 5.1 and above,
|
|
|
|
including alternative runtimes like LuaJIT.
|
2011-07-16 03:27:28 +00:00
|
|
|
|
2011-08-11 04:47:39 +00:00
|
|
|
See <http://moonscript.org>.
|
2011-07-16 03:36:39 +00:00
|
|
|
|
2011-10-12 16:57:23 +00:00
|
|
|
Online demo/compiler at <http://moonscript.org/compiler>.
|
2011-07-16 03:27:28 +00:00
|
|
|
|
2013-06-07 00:27:49 +00:00
|
|
|
## Running Tests
|
|
|
|
|
2013-06-08 06:14:08 +00:00
|
|
|
Tests are written in MoonScript and use [Busted](http://olivinelabs.com/busted/).
|
|
|
|
In order to run the tests you must have MoonScript installed.
|
|
|
|
|
|
|
|
To run tests, execute from the root directory:
|
2013-06-07 00:27:49 +00:00
|
|
|
|
|
|
|
```bash
|
2013-06-08 06:14:08 +00:00
|
|
|
busted
|
2013-06-07 00:27:49 +00:00
|
|
|
```
|
|
|
|
|
2015-09-27 02:42:28 +00:00
|
|
|
Writing specs is a bit more complicated. Check out [the spec writing guide](spec/README.md).
|
|
|
|
|
2015-12-28 10:12:50 +00:00
|
|
|
|
2016-09-25 20:11:39 +00:00
|
|
|
## Binaries
|
|
|
|
|
|
|
|
Precompiled versions of MoonScript are provided for Windows. You can find them
|
|
|
|
in the [GitHub releases page](https://github.com/leafo/moonscript/releases).
|
|
|
|
(Scroll down to the `win32-` tags.
|
|
|
|
|
|
|
|
The build code can be found in the [`binaries`
|
|
|
|
branch](https://github.com/leafo/moonscript/tree/binaries)
|
|
|
|
|
2015-12-28 10:12:50 +00:00
|
|
|
## Editor Support
|
|
|
|
|
|
|
|
* [Vim](https://github.com/leafo/moonscript-vim)
|
|
|
|
* [Textadept](https://github.com/leafo/moonscript-textadept)
|
|
|
|
* [Sublime/Textmate](https://github.com/leafo/moonscript-tmbundle)
|
2016-10-08 17:49:36 +00:00
|
|
|
* [Emacs](https://github.com/k2052/moonscript-mode)
|
2015-12-28 10:12:50 +00:00
|
|
|
|
2011-07-16 03:27:28 +00:00
|
|
|
## License (MIT)
|
|
|
|
|
2015-02-28 20:47:21 +00:00
|
|
|
Copyright (C) 2015 by Leaf Corcoran
|
2011-07-16 03:27:28 +00:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|