Skip to content

Commit df5ffc2

Browse files
committed
Updated readme.
1 parent ba511ab commit df5ffc2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
[![Ubuntu](https://github.com/pigpigyyy/Yuescript/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/pigpigyyy/Yuescript/actions/workflows/ubuntu.yml) [![Windows](https://github.com/pigpigyyy/Yuescript/actions/workflows/windows.yml/badge.svg)](https://github.com/pigpigyyy/Yuescript/actions/workflows/windows.yml) [![macOS](https://github.com/pigpigyyy/Yuescript/actions/workflows/macos.yml/badge.svg)](https://github.com/pigpigyyy/Yuescript/actions/workflows/macos.yml) [![Discord Badge](https://img.shields.io/discord/844031511208001577?color=5865F2&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/cRJ2VAm2NV)
66

7-
Yuescript is a Moonscript dialect. It is derived from [Moonscript language](https://github.com/leafo/moonscript) 0.5.0 and continuously adopting new features to be more up to date.
7+
YueScript is a MoonScript dialect. It is derived from [MoonScript language](https://github.com/leafo/moonscript) 0.5.0 and continuously adopting new features to be more up to date.
88

9-
Moonscript is a language that compiles to Lua. Since original Moonscript has been used to write web framework [lapis](https://github.com/leafo/lapis) and run a few business web sites like [itch.io](https://itch.io) and [streak.club](https://streak.club) with some large code bases. The original language is getting too hard to adopt new features for those may break the stablility for existing applications.
9+
MoonScript is a language that compiles to Lua. Since original MoonScript has been used to write web framework [lapis](https://github.com/leafo/lapis) and run a few business web sites like [itch.io](https://itch.io) and [streak.club](https://streak.club) with some large code bases. The original language is getting too hard to adopt new features for those may break the stablility for existing applications.
1010

11-
So Yuescript is a new code base for pushing the language to go forward and being a playground to try introducing new language syntax or programing paradigms to make Moonscript language more expressive and productive.
11+
So YueScript is a new code base for pushing the language to go forward and being a playground to try introducing new language syntax or programing paradigms to make MoonScript language more expressive and productive.
1212

1313
Yue (月) is the name of moon in Chinese and it's pronounced as [jyɛ].
1414

@@ -18,7 +18,7 @@ Yue (月) is the name of moon in Chinese and it's pronounced as [jyɛ].
1818

1919
* No other dependencies needed except modified [parserlib](https://github.com/axilmar/parserlib) library from Achilleas Margaritis with some performance enhancement. **lpeg** library is no longer needed.
2020
* Written in C++17.
21-
* Support most of the features from Moonscript language. Generate Lua codes in the same way like the original compiler.
21+
* Support most of the features from MoonScript language. Generate Lua codes in the same way like the original compiler.
2222
* Reserve line numbers from source file in the compiled Lua codes to help debugging.
2323
* More features like macro, existential operator, pipe operator, Javascript-like export syntax and etc.
2424
* See other details in the [changelog](./CHANGELOG.md). Find document [here](http://yuescript.org).
@@ -43,7 +43,7 @@ Yue (月) is the name of moon in Chinese and it's pronounced as [jyɛ].
4343
> luarocks install yuescript
4444
```
4545

46-
  Then require the Yuescript module in Lua:
46+
  Then require the YueScript module in Lua:
4747

4848
```Lua
4949
require("yue")("main") -- require `main.yue`
@@ -69,17 +69,17 @@ f!
6969
> make install
7070
```
7171

72-
  Build Yuescript tool without macro feature:
72+
  Build YueScript tool without macro feature:
7373
```sh
7474
> make install NO_MACRO=true
7575
```
7676

77-
  Build Yuescript tool without built-in Lua binary:
77+
  Build YueScript tool without built-in Lua binary:
7878
```sh
7979
> make install NO_LUA=true
8080
```
8181

82-
  Use Yuescript tool with:
82+
  Use YueScript tool with:
8383

8484
```sh
8585
> yue -h
@@ -110,18 +110,18 @@ Usage: yue [options|files|directories] ...
110110
in a single line to start/stop multi-line mode
111111
```
112112
  Use cases:
113-
  Recursively compile every Yuescript file with extension `.yue` under current path: `yue .`
113+
  Recursively compile every YueScript file with extension `.yue` under current path: `yue .`
114114
  Compile and save results to a target path: `yue -t /target/path/ .`
115115
  Compile and reserve debug info: `yue -l .`
116116
  Compile and generate minified codes: `yue -m .`
117117
  Execute raw codes: `yue -e 'print 123'`
118-
  Execute a Yuescript file: `yue -e main.yue`
118+
  Execute a YueScript file: `yue -e main.yue`
119119
120120
121121
122122
## Editor Support
123123
124-
* [Vim](https://github.com/pigpigyyy/Yuescript-vim)
124+
* [Vim](https://github.com/pigpigyyy/YueScript-vim)
125125
* [ZeroBraneStudio](https://github.com/pkulchenko/ZeroBraneStudio/issues/1134) (Syntax highlighting)
126126
* [Visual Studio Code](https://github.com/pigpigyyy/yuescript-vscode)
127127

0 commit comments

Comments
 (0)