Skip to content

Commit

Permalink
更新了文档
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartwang committed Nov 4, 2019
1 parent e8d78ef commit cecfac6
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 9 deletions.
3 changes: 1 addition & 2 deletions Docs/Development-instructions/project-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
│   ├── debugger_lib
│   │ ├── libpdebug.h/cpp C调试库源码
│   │ └── plugins 打包好的调试库文件
│   ├── LuaPanda.lua Debugger源码
│   └── DebugTools.lua Debugger工具文件
│   └── LuaPanda.lua Debugger源码
├── Docs 项目文档
├── LICENSE.txt 证书
├── package.json 工程配置文件
Expand Down
2 changes: 1 addition & 1 deletion Docs/Manual/access-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ launch.json文件中配置项 `"autoPathMode": true/false` 可以设置是否使

### 第二步 放入debugger 文件,并引用

文件:`LuaPanda.lua`, `DebugTools.lua`
文件:`LuaPanda.lua`

下载位置:github 的 `Debugger` 目录下

Expand Down
8 changes: 4 additions & 4 deletions Docs/Manual/quick-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

1. **下载 slua 工程** 下载 slua 工程源码 https://github.com/pangweiwei/slua
2. **slua 工程设置** 使用 Unity 打开 slua 工程,切换工程平台到 Android/iOS , 点击菜单 Slua -> All -> Make,选择 `Slua/Editor/example/Circle` 场景。
3. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua, DebugTools.lua` 两个文件拷贝到slua工程 `Slua/Resources/` 目录下, 并修改文件后缀为 `.txt`
3. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua` 文件拷贝到slua工程 `Slua/Resources/` 目录下, 并修改文件后缀为 `.txt`
4. **配置工程** VSCode 打开 `Slua/Resources/` 目录,点击 VSCode 调试选项卡下的齿轮图标,选择 LuaPanda。把配置项 luaFileExtension 值修改为 "txt"。
5. **开始调试**`Slua/Resources/circle/circle.txt` 中加入代码 `require("LuaPanda").start("127.0.0.1",8818)`. VSCode切换到调试选项卡,配置项选择`LuaPanda`,点击 VSCode 调试的绿色箭头,再运行Unity,在加入 require 的位置后会自动停止。也可以打断点调试

Expand All @@ -37,7 +37,7 @@
### xlua

1. **下载 xlua 工程** https://github.com/Tencent/xLua
2. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua, DebugTools.lua` 两个文件拷贝到xlua工程 `\XLua\Examples\07_AsyncTest\Resources` 目录下, 并修改后缀为 `.lua.txt`
2. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua` 文件拷贝到xlua工程 `\XLua\Examples\07_AsyncTest\Resources` 目录下, 并修改后缀为 `.lua.txt`
3. **配置工程**`\XLua\Examples\07_AsyncTest\Resources` 文件夹放入 VSCode , 点击 VSCode 调试选项卡下的齿轮图标,选择 LuaPanda。把配置项 luaFileExtension 值修改为 "lua.txt"
4. **开始调试**`\XLua\Examples\07_AsyncTest\Resources\async_test.lua.txt` 中加入`require("LuaPanda").start("127.0.0.1",8818)` 。VSCode切换到调试选项卡,配置项选择`LuaPanda`, 点击 VSCode 的开始调试箭头,运行Unity,在加入 require 的位置后会自动停止。也可以打断点调试。

Expand All @@ -46,7 +46,7 @@
### slua-unreal

1. **下载slua-unreal工程** https://github.com/Tencent/sluaunreal
2. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua, DebugTools.lua` 两个文件拷贝到slua-unreal 工程`sluaunreal/Content/Lua/`目录下
2. **放入调试文件** 把github中 /Debugger 下的 `LuaPanda.lua` 文件拷贝到slua-unreal 工程`sluaunreal/Content/Lua/`目录下
3. **配置工程**`sluaunreal/Content`文件夹放入 VSCode , 点击 VSCode 调试选项卡下的齿轮图标,选择 LuaPanda。
4. **开始调试** 在执行的lua代码中加入`require("LuaPanda").start("127.0.0.1",8818)` 。VSCode切换到调试选项卡,配置项选择`LuaPanda`, 点击 VSCode 的开始调试箭头,再运行ue4,在加入 require 的位置后会自动停止。之后可以打断点调试。

Expand All @@ -58,7 +58,7 @@

1. 下载cocos2dx并创建新工程

2. **放入调试器文件** 把github中 /Debugger 下的 `LuaPanda.lua, DebugTools.lua` 两个文件拷贝到cocos2dx工程 /src下,和main.lua 文件同级
2. **放入调试器文件** 把github中 /Debugger 下的 `LuaPanda.lua` 文件拷贝到cocos2dx工程 /src下,和main.lua 文件同级
3. **配置工程**`src`文件夹拖入 VSCode , 点击 VSCode 调试选项卡下的齿轮图标,选择 LuaPanda。

4. **开始调试** 在main.lua文件 `require "cocos.init"` 行之前加入代码 `require("LuaPanda").start("127.0.0.1",8818)` 。VSCode切换到调试选项卡,配置项选择`LuaPanda`, 点击 VSCode 的开始调试箭头,再运行cocos2dx工程,在加入 require 的位置后会自动停止。之后可以打断点调试。
2 changes: 1 addition & 1 deletion Docs/Manual/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

+ lua文件。 下载地址:https://github.com/Tencent/LuaPanda/releases

LuaPanda.lua,DebugTools.lua
LuaPanda.lua

需要用户手动下载最新的文件,替换工程中原有文件。

Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ LuaPanda 的立项源于潘多拉项目中大量的lua调试需求。`潘多拉`

另外调试器目前支持标准lua虚拟机,cocos2dx集成的是luajit,可能会在单步时出现跳步的情况,后续完整支持luajit会解决此问题。

如希望体验新功能,请按照 [升级说明](./Docs/Manual/update.md) 手动替换工程中的 `LuaPanda.lua,DebugTools.lua` 文件。
如希望体验新功能,请按照 [升级说明](./Docs/Manual/update.md) 手动替换工程中的 `LuaPanda.lua` 文件。



Expand Down

0 comments on commit cecfac6

Please sign in to comment.