diff options
| author | Li Jin <dragon-fly@qq.com> | 2020-10-09 15:58:35 +0800 |
|---|---|---|
| committer | Li Jin <dragon-fly@qq.com> | 2020-10-09 15:58:35 +0800 |
| commit | 721946718de7bc4e90c94a7f44bf8e7d519a75e5 (patch) | |
| tree | 65ab681a7d486293aba7afbfa2f59718d8506598 /README.md | |
| parent | 97bbe98289fb74c7cf2d9793b80a1a27b4146045 (diff) | |
| download | yuescript-721946718de7bc4e90c94a7f44bf8e7d519a75e5.tar.gz yuescript-721946718de7bc4e90c94a7f44bf8e7d519a75e5.tar.bz2 yuescript-721946718de7bc4e90c94a7f44bf8e7d519a75e5.zip | |
update readme.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 15 insertions, 4 deletions
| @@ -43,7 +43,7 @@ So MoonPlus is a new code base for pushing the language to go forward and being | |||
| 43 |   Then require the module in Lua: | 43 |   Then require the module in Lua: |
| 44 | 44 | ||
| 45 | ```Lua | 45 | ```Lua |
| 46 | require("moonp")("main") -- require `main.moon` | 46 | require("moonp")("main") -- require `main.mp` |
| 47 | 47 | ||
| 48 | local moonp = require("moonp") | 48 | local moonp = require("moonp") |
| 49 | local codes, err, globals = moonp.to_lua([[ | 49 | local codes, err, globals = moonp.to_lua([[ |
| @@ -59,7 +59,6 @@ f! | |||
| 59 | 59 | ||
| 60 | 60 | ||
| 61 | 61 | ||
| 62 | |||
| 63 | * **Binary Tool** | 62 | * **Binary Tool** |
| 64 | 63 | ||
| 65 |   Clone this repo, then build and install executable with: | 64 |   Clone this repo, then build and install executable with: |
| @@ -91,14 +90,26 @@ Usage: moonp [options|files|directories] ... | |||
| 91 | in a single line to start/stop multi-line mode | 90 | in a single line to start/stop multi-line mode |
| 92 | ``` | 91 | ``` |
| 93 |   Use cases: | 92 |   Use cases: |
| 94 |   Recursively compile every moon file under current path: `moonp .` | 93 |   Recursively compile every moon+ file with extension `.md` under current path: `moonp .` |
| 95 |   Compile and save results to a target path: `moonp -t /target/path/ .` | 94 |   Compile and save results to a target path: `moonp -t /target/path/ .` |
| 96 |   Compile and reserve debug info: `moonp -l .` | 95 |   Compile and reserve debug info: `moonp -l .` |
| 97 |   Compile and generate minified codes: `moonp -m .` | 96 |   Compile and generate minified codes: `moonp -m .` |
| 98 |   Execute raw codes: `moonp -e 'print 123'` | 97 |   Execute raw codes: `moonp -e 'print 123'` |
| 99 |   Execute a moon file: `moonp -e main.moon` | 98 |   Execute a moon+ file: `moonp -e main.mp` |
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | * **Docker Hub** | ||
| 103 | Try moonp in another easy way: https://hub.docker.com/r/moonplus/moonplus | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | ## Editor Support | ||
| 108 | |||
| 109 | * [Vim](https://github.com/pigpigyyy/MoonPlus-vim) | ||
| 100 | 110 | ||
| 101 | 111 | ||
| 102 | 112 | ||
| 103 | ## License | 113 | ## License |
| 114 | |||
| 104 | MIT | 115 | MIT |
