diff --git a/readme.md b/readme.md index ff23ac7..cff9c8e 100644 --- a/readme.md +++ b/readme.md @@ -1,114 +1,71 @@ -# LuaPanda +#LuaPanda -LuaPanda 是一个基于 VS Code 的 lua 代码工具，设计目标是简单易用。它支持多种开发框架，主要提供以下功能： +[Project introduction] (. /Docs/Manual/feature-introduction.md) | [Quick Trial Guide] (. /Docs/Manual/quick-use.md) | [Debugger Access Guide](. /Docs/Manual/access-guidelines.md) | [real machine debugging](. /Docs/Manual/debug-on-phone.md) | [Other debugging capabilities](. /Docs/Manual/common-functions.md) | [Upgrade Instructions](. /Docs/Manual/update.md) | [FAQ](. /Docs/Manual/FAQ.md) -- 代码补全（code completion） -- 代码片段（snippet completion） -- 定义跳转（definition） -- 生成注释（comment generation） -- 类型推断（limited type inference） -- 代码格式化（formatting）: 依赖 [lua-fmt](https://github.com/trixnz/lua-fmt) -- 代码诊断（linting）：依赖 [luacheck](https://github.com/mpeterv/luacheck) -- 调试器（debugger） +More documents -功能详情可以参考[项目介绍](./Docs/Manual/feature-introduction.md)。LuaPanda 支持 lua5.1- 5.4，**调试器运行环境需要包含 luasocket**。 +[All documents](. /Docs) +# Characteristics ++ Support commonly used code completion, code snippet, definition jump, generate comments, symbol list and other functions -# 文档 ++ Support single-step debugging, breakpoint debugging, conditional breakpoint, and co-process debugging -接入和使用文档 ++ Support lua5.1 - 5.4, win/mac platform, support slua/xlua/slua-unreal and other frameworks -[项目介绍](./Docs/Manual/feature-introduction.md) | [快速试用指引](./Docs/Manual/quick-use.md) | [调试器接入指引](./Docs/Manual/access-guidelines.md) | [真机调试](./Docs/Manual/debug-on-phone.md) | [其他调试能力](./Docs/Manual/common-functions.md) | [升级说明](./Docs/Manual/update.md) | [FAQ](./Docs/Manual/FAQ.md) ++ Support REPL: You can monitor and run expressions at breakpoints and return execution results. -更多文档 ++ The hook frequency can be automatically adjusted according to the density of breakpoints, which has better efficiency. -[全部文档](./Docs) ++ Support attach mode, and you can establish a connection at any time during lua operation. ++ Use lua / C dual debugging engine. The lua part can be sent dynamically to avoid the inability to debug after packaging. Part C is highly efficient and suitable for debugging during the development period. ++ Support multi-target debugging, which can debug multiple lua processes at the same time. +# Recent updates -# 特性 +Version 3.2.0 cannot run on VSCode 1.82 because the dependency library is too old. You can update 3.3.0 to solve this problem. For details, see #171 -+ 支持常用的代码补全，代码片段，定义跳转，生成注释，符号列表等功能 ++V3.3.0 -+ 支持单步调试，断点调试，条件断点，协程调试 ++ Fixed the problem of plug-in execution errors under VSCode 1.82 -+ 支持lua5.1 - 5.4, win/mac 平台，支持 slua/xlua/slua-unreal 等框架 ++ lua 504 under mac arm / win x64 has supported chook. There is no machine testing on other platforms, so there is no libpdebug library. If necessary, you can package the plibdebug library by yourself, or you can mention mr. -+ 支持REPL : 在断点处可以监视和运行表达式，并返回执行结果 ++ Updated the mr between versions -+ 可以根据断点密集程度自动调整 hook 频率，有较好的效率 ++ #108 When the debugging start is relatively late, the co-process that has been created cannot be debugged / the debugging stack is interrupted when it encounters the c function. -+ 支持 attach 模式，lua 运行过程中可随时建立连接 ++ #114 Fix the bug that when there is a C function in the debugging stack, the variable of the monitoring is obtained incorrectly -+ 使用 lua / C 双调试引擎。lua 部分可动态下发，避免打包后无法调试。C 部分效率高，适合开发期调试。 ++ #109 Unable to dynamically attach to debug -+ 支持多目标调试(multi target) ，可以同时调试多个 lua 进程。 ++ #139 made an error caused by inconsistent default behaviour of luasocket sock:receive() under 5.4.3 - ++ #152 launch.json Startup parameter program path with space will fail to start -# 近期更新 ++ Because the dependent library version is too old to be compatible with the new version of VSCode, the export symbol has been deleted for the code prompt function. -​ 3.2.0 版本因依赖库太旧，无法在 VSCode 1.82 上运行，可更新 3.3.0 解决此问题，详见 #171 ++V3.2.0 ++ Code prompts support case-insensitive, and the corresponding symbols can be prompted regardless of the case. ++ Support multi-target, which can start multiple different port debugging terminals in a VSCode panel and connect multiple lua processes. -+ V3.3.0 ++ Support inverting client-server. At present, the vscode plug-in acts as the server, and the lua process acts as the client. Support setting inversion, which is convenient for real machine debugging. - + 修复了 VSCode 1.82 下插件执行错误的问题 - + lua 504 下 mac arm / win x64 已支持 chook，其他平台没有机器测试，所以未出 libpdebug 库。有需要大家可以自行打包 plibdebug 库，也可提 mr。 - + 更新了版本间的 mr - + #108 调试启动比较晚时，已经创建的协程无法调试 / 调试堆栈碰到c函数被打断 - + #114 修复调试栈中有C函数时，监听的变量获取错误的bug - + #109 无法动态attach到debug - + #139 做了 5.4.3 下 luasocket sock:receive() 默认行为不一致导致的错误 - + #152 launch.json 启动参数 program 路径带有空格则启动失败 - + 因依赖库版本太旧无法兼容新版本 VSCode，删除了导出符号用于代码提示功能 ++ Support require path contains . , currently only require("A/B") is supported, and the subsequent support is the form of require("A.B"), no need to set - ++ Support files of the same name in autoPath mode -+ V3.2.0 - + 代码提示支持大小写不敏感，无论输入大小写都能提示对应的符号。 - + 支持多端调试(multi target)， 在一个VSCode面板中可以启动多个不同port的调试端，连接多个lua进程。 - + 支持反转client-server。目前 vscode 插件作为 server , lua 进程作为 client。支持通过设置反转，方便真机调试。 - + 支持require 路径中含有 . , 目前只支持require("A/B"), 后续支持require("A.B")的形式，无需设置 - + 在autoPath模式支持同名文件 - + 重新测试和优化真机调试，修复真机调试socket连接可能存在的问题 ++ Retest and optimise the real machine debugging, and fix the possible problems of the real machine debugging socket connection -+ [更多更新记录](./CHANGELOG.md) ++ [More updated records](. /CHANGELOG.md) +# Dependence and applicability +The debugger function depends on luasocket and can run in slua, slua-unreal, xlua and other development environments that have integrated luasocket. When running in other environments (such as console), users need to guarantee l Uasocket is available. -# 依赖和适用性 - -调试器功能依赖 luasocket , 可运行于 slua，slua-unreal ，xlua 等已集成 luasocket 的开发环境，在其他环境（如 console）中运行时，需要用户自行保证 luasocket 可用 。 - -其他依赖项目（插件中已包含，无需用户手动安装）： - -+ [**luaparse**](https://github.com/oxyc/luaparse) - -+ [**luacheck**](https://github.com/mpeterv/luacheck) - -+ [**lua-fmt**](https://github.com/trixnz/lua-fmt) - -+ [**path-reader**](https://github.com/ackerapple/path-reader) - - - -# 参与贡献 - -我们非常期待您的贡献，无论是完善文档，提出、修复 Bug 或是增加新特性。 -如果您在使用过程中发现文档不够完善，欢迎记录下来并提交。 -如果发现 bug，请通过 [issues](https://github.com/Tencent/LuaPanda/issues) 来提交并描述相关的问题，您也可以在这里查看其它的 issue，通过解决这些 issue 来贡献代码。 - -请将pull request提交在 `dev` 分支上，经过测试后会在下一版本合并到 `master` 分支。更多规范请看[CONTRIBUTING](./CONTRIBUTING.md) - -[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。 - - - -# 技术支持 - -如有问题可以先参阅 [文档](./Docs)， 可以使用 [issues](https://github.com/Tencent/LuaPanda/issues) ，我会关注和回复。 - +Other dependent items (inclued in the plug-in, no need for manual installation by the user):