Quellcode durchsuchen

Improve quickstart (#81)

* 基于 xmake2.7.1 构建 docker 镜像,并依据自己的使用体验完善文档细节内容

* 依据自己的使用体验完善文档细节内容,移除了 docker 相关的文档手册

* 依据自己的使用体验完善文档细节内容,移除了 docker 相关的文档手册

* 完善v2.7.1中文文档

* 完善v2.7.1中文文档

* v2.7.1 文档完善

* Improve v2.7.1 documentation

* Update quickstart.md

* Update quickstart.md

Co-authored-by: ruki <[email protected]>
肥猫零零七 vor 3 Jahren
Ursprung
Commit
f266c8a74c
4 geänderte Dateien mit 28 neuen und 12 gelöschten Zeilen
  1. 1 1
      guide/installation.md
  2. 13 3
      guide/quickstart.md
  3. 1 1
      zh-cn/guide/installation.md
  4. 13 7
      zh-cn/guide/quickstart.md

+ 1 - 1
guide/installation.md

@@ -209,7 +209,7 @@ sudo make uninstall
 Starting with v2.2.3, the `xmake update` command has been added to quickly update and upgrade itself. The default is to upgrade to the latest version. Of course, you can also specify to upgrade or roll back to a version:
 
 ```bash
-xmake update 2.2.4
+xmake update 2.7.1
 ```
 
 We can also specify an update to the master/dev branch version:

+ 13 - 3
guide/quickstart.md

@@ -51,6 +51,7 @@ Supported Languages
 ## Build Project
 
 ```bash
+$ cd hello
 $ xmake
 ```
 
@@ -62,6 +63,15 @@ $ xmake run hello
 
 ## Debug Program
 
+To debug the hello, you need change to the debug mode and build it.
+
+```bash
+$ xmake config -m debug 
+$ xmake
+```
+
+Then run the following command to debug target program.
+
 ```bash
 $ xmake run -d hello 
 ```
@@ -86,7 +96,7 @@ hello`main:
 [lldb]$
 ```
 
-<p class="tip">
-    You can also use short command option, for example: `xmake r` or `xmake run`
-</p>
+To study more debug command, please click the url [GDB to LLDB command map](https://lldb.llvm.org/use/map.html)
+
+!> You can also use short command option, for example: `xmake r` or `xmake run`
 

+ 1 - 1
zh-cn/guide/installation.md

@@ -228,7 +228,7 @@ sudo make uninstall
 从v2.2.3版本开始,新增了`xmake update`命令,来快速进行自我更新和升级,默认是升级到最新版本,当然也可以指定升级或者回退到某个版本:
 
 ```bash
-xmake update 2.2.4
+xmake update 2.7.1
 ```
 
 我们也可以指定更新到master/dev分支版本:

+ 13 - 7
zh-cn/guide/quickstart.md

@@ -38,13 +38,12 @@ target("hello")
 * golang
 * rust
 
-<p class="tip">
-    如果你想了解更多参数选项,请运行: `xmake create --help`
-</p>
+!> 如果你想了解更多参数选项,请运行: `xmake create --help`
 
 ## 构建工程
 
 ```bash
+$ cd hello
 $ xmake
 ```
 
@@ -56,11 +55,20 @@ $ xmake run hello
 
 ## 调试程序
 
+首先你需要切换到 debug 模式去重新编译程序。
+
+```bash
+$ xmake config -m debug 
+$ xmake
+```
+
+然后执行下面的命令去开始调试:
+
 ```bash
 $ xmake run -d hello 
 ```
 
-xmake将会使用系统自带的调试器去加载程序运行,目前支持:lldb, gdb, windbg, vsjitdebugger, ollydbg 等各种调试器。
+Xmake 将会使用系统自带的调试器去加载程序运行,目前支持:lldb, gdb, windbg, vsjitdebugger, ollydbg 等各种调试器。
 
 ```bash
 [lldb]$target create "build/hello"
@@ -80,7 +88,5 @@ hello`main:
 [lldb]$
 ```
 
-<p class="tip">
-    你也可以使用简写的命令行选项,例如: `xmake r` 或者 `xmake run`
-</p>
+!> 你也可以使用简写的命令行选项,例如: `xmake r` 或者 `xmake run`