aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLi Jin <dragon-fly@qq.com>2025-01-08 09:54:53 +0800
committerLi Jin <dragon-fly@qq.com>2025-01-08 09:54:53 +0800
commit84b4744f967cf6488236bd1360b15c6c40ea17b9 (patch)
treed5695b123c83daa58b48ccc7eab6db4bdf8fdd2e
parente1fb0ca515c7b4e79b78cdc8b0352718a1b03dc4 (diff)
downloadyuescript-84b4744f967cf6488236bd1360b15c6c40ea17b9.tar.gz
yuescript-84b4744f967cf6488236bd1360b15c6c40ea17b9.tar.bz2
yuescript-84b4744f967cf6488236bd1360b15c6c40ea17b9.zip
Updated readme.
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 046fee4..51ab627 100644
--- a/README.md
+++ b/README.md
@@ -14,9 +14,15 @@ Yue (月) is the name of moon in Chinese and it's pronounced as [jyɛ].
14 14
15 15
16 16
17## About Dora SSR
18
19YueScript is being developed and maintained alongside the open-source game engine [Dora SSR](https://github.com/ippclub/Dora-SSR). It has been used to create engine tools, game demos and prototypes, validating its capabilities in real-world scenarios while enhancing the Dora SSR development experience.
20
21
22
17## Features 23## Features
18 24
19* 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. 25* Based on modified [parserlib](https://github.com/axilmar/parserlib) library from Achilleas Margaritis with some performance enhancement. **lpeg** library is no longer needed.
20* Written in C++17. 26* Written in C++17.
21* Support most of the features from MoonScript language. Generate Lua codes in the same way like the original compiler. 27* Support most of the features from MoonScript language. Generate Lua codes in the same way like the original compiler.
22* Reserve line numbers from source file in the compiled Lua codes to help debugging. 28* Reserve line numbers from source file in the compiled Lua codes to help debugging.
@@ -50,8 +56,7 @@ require("yue")("main") -- require `main.yue`
50 56
51local yue = require("yue") 57local yue = require("yue")
52local codes, err, globals = yue.to_lua([[ 58local codes, err, globals = yue.to_lua([[
53f = -> 59f = -> print "hello world"
54 print "hello world"
55f! 60f!
56]],{ 61]],{
57 implicit_return_root = true, 62 implicit_return_root = true,