update readme

waruqi · waruqi · commit 791bae90ac0f · 2026-01-17T00:40:28.000+08:00
diff --git a/README.md b/README.md
@@ -20,19 +20,19 @@
     <a href="https://github.com/xmake-io/xmake-vscode/blob/master/LICENSE.md">
       <img src="https://img.shields.io/github/license/tboox/xmake-vscode.svg?colorB=f48041&style=flat-square" alt="license" />
     </a>
-    <a href="https://www.reddit.com/r/tboox/">
+    <a href="https://www.reddit.com/r/xmake/">
       <img src="https://img.shields.io/badge/chat-on%20reddit-ff3f34.svg?style=flat-square" alt="Reddit" />
     </a>
-    <a href="https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
-      <img src="https://img.shields.io/gitter/room/tboox/tboox.svg?style=flat-square&colorB=96c312" alt="Gitter" />
+    <a href="https://discord.gg/xmake">
+      <img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square" alt="Discord" />
     </a>
     <a href="https://t.me/tbooxorg">
       <img src="https://img.shields.io/badge/chat-on%20telegram-blue.svg?style=flat-square" alt="Telegram" />
     </a>
     <a href="https://jq.qq.com/?_wv=1027&k=5hpwWFv">
       <img src="https://img.shields.io/badge/chat-on%20QQ-ff69b4.svg?style=flat-square" alt="QQ" />
     </a>
-    <a href="http://xmake.io/pages/donation.html#donate">
+    <a href="https://xmake.io/about/sponsor.html">
       <img src="https://img.shields.io/badge/donate-us-orange.svg?style=flat-square" alt="Donate" />
     </a>
   </div>
@@ -46,20 +46,22 @@ A XMake integration in Visual Studio Code.
 
 You need install [xmake](https://github.com/xmake-io/xmake) first and a project with `xmake.lua`.
 
-Please see [xmake-github](https://github.com/xmake-io/xmake) and [website](http://xmake.io) if you want to known more about xmake.
+Please see [xmake-github](https://github.com/xmake-io/xmake) and [website](https://xmake.io) if you want to known more about xmake.
 
 ## Features
 
-* Quickstart
-* Colorization
-* Completion Lists
-* StatusBar
-* Commands
-* Configuration
-* Build
-* Run and Debug
-* Record and Playback
-* Problem
+* **Project Management**: Create new projects, add files, and manage project structure
+* **Language Support**: Colorization and syntax highlighting for `xmake.lua` files
+* **IntelliSense**: Auto-completion for XMake APIs and functions
+* **Status Bar**: Quick access to build configuration and actions
+* **Command Palette**: Full integration with VS Code commands
+* **Configuration Management**: Configure platforms, architectures, toolchains, and build modes
+* **Build System**: Build, rebuild, clean, and package projects
+* **Run and Debug**: Integrated debugging with multiple debugger support
+* **Problem Detection**: Real-time error and warning detection
+* **Macro Recording**: Record and playback command sequences
+* **File Explorer**: Dedicated XMake project explorer with target management
+* **Task Integration**: VS Code tasks support for XMake commands
 
 ## Quickstart
 
@@ -181,65 +183,272 @@ XMake envs will only be replaced for the same key, if another xmake env key is p
 
 We can configure them in settings.json
 
+### Basic Configuration
+
+```json
+{
+    "xmake.executable": "xmake",
+    "xmake.logLevel": "normal",
+    "xmake.buildLevel": "normal",
+    "xmake.buildDirectory": "${workspaceRoot}/build",
+    "xmake.workingDirectory": "${workspaceRoot}"
+}
+```
+
+### Advanced Configuration
+
+```json
+{
+    "xmake.executable": "xmake",
+    "xmake.logLevel": "normal",
+    "xmake.buildLevel": "normal",
+    "xmake.buildDirectory": "${workspaceRoot}/build",
+    "xmake.installDirectory": "",
+    "xmake.packageDirectory": "",
+    "xmake.workingDirectory": "${workspaceRoot}",
+    "xmake.androidNDKDirectory": "",
+    "xmake.QtDirectory": "",
+    "xmake.WDKDirectory": "",
+    "xmake.compileCommandsDirectory": ".vscode",
+    "xmake.compileCommandsBackend": "clangd",
+    "xmake.additionalConfigArguments": [],
+    "xmake.runningTargetsArguments": {
+        "default": []
+    },
+    "xmake.debuggingTargetsArguments": {
+        "default": []
+    },
+    "xmake.debugConfigType": "default",
+    "xmake.customDebugConfig": {},
+    "xmake.envBehaviour": "merge",
+    "xmake.enableSyntaxCheck": true,
+    "xmake.runMode": "runOnly"
+}
+```
+
+### Status Bar Configuration
+
+Control which buttons appear in the status bar:
+
 ```json
 {
-    "configuration": {
-        "type": "object",
-        "title": "XMake configuration",
-        "properties": {
-            "xmake.executable": {
-                "type": "string",
-                "default": "xmake",
-                "description": "The xmake executable name / path"
-            },
-            "xmake.logLevel": {
-                "type": "string",
-                "default": "normal",
-                "description": "The Log Level: normal/verbose/minimal",
-                "enum": [
-                    "verbose",
-                    "normal",
-                    "minimal"
-                ]
-            },
-            "xmake.buildLevel": {
-                "type": "string",
-                "default": "normal",
-                "description": "The Build Output Level: normal/verbose/warning/debug",
-                "enum": [
-                    "verbose",
-                    "normal",
-                    "warning",
-                    "debug"
-                ]
-            },
-            "xmake.buildDirectory": {
-                "type": "string",
-                "default": "${workspaceRoot}/build",
-                "description": "The Build Output Directory"
-            },
-            "xmake.installDirectory": {
-                "type": "string",
-                "default": "",
-                "description": "The Install Output Directory"
-            },
-            "xmake.packageDirectory": {
-                "type": "string",
-                "default": "",
-                "description": "The Package Output Directory"
-            },
-            "xmake.workingDirectory": {
-                "type": "string",
-                "default": "${workspaceRoot}",
-                "description": "The Project Working Directory with the root xmake.lua"
-            },
-            "xmake.androidNDKDirectory": {
-                "type": "string",
-                "default": "",
-                "description": "The Android NDK Directory"
+    "xmake.status.showProject": false,
+    "xmake.status.showXMake": true,
+    "xmake.status.showPlatform": false,
+    "xmake.status.showArch": false,
+    "xmake.status.showMode": false,
+    "xmake.status.showToolchain": false,
+    "xmake.status.showTarget": false,
+    "xmake.status.showBuild": true,
+    "xmake.status.showRun": true,
+    "xmake.status.showDebug": true
+}
+```
+
+### Configuration Options Details
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| **xmake.executable** | string | "xmake" | The xmake executable name / path |
+| **xmake.logLevel** | string | "normal" | Log Level: `verbose`, `normal`, `minimal` |
+| **xmake.buildLevel** | string | "normal" | Build Output Level: `verbose`, `normal`, `debug` |
+| **xmake.runMode** | string | "runOnly" | Run Mode: `runOnly`, `buildRun` |
+| **xmake.buildDirectory** | string | "${workspaceRoot}/build" | Build Output Directory |
+| **xmake.installDirectory** | string | "" | Install Output Directory |
+| **xmake.packageDirectory** | string | "" | Package Output Directory |
+| **xmake.workingDirectory** | string | "${workspaceRoot}" | Project Working Directory |
+| **xmake.androidNDKDirectory** | string | "" | Android NDK Directory |
+| **xmake.QtDirectory** | string | "" | Qt Directory |
+| **xmake.WDKDirectory** | string | "" | Windows Driver Kit Directory |
+| **xmake.compileCommandsDirectory** | string | ".vscode" | compile_commands.json file directory |
+| **xmake.compileCommandsBackend** | string | "clangd" | LSP backend for compile_commands |
+| **xmake.additionalConfigArguments** | array | [] | Additional config arguments, e.g. `["--cc=gcc", "--myopt=xxx"]` |
+| **xmake.runningTargetsArguments** | object | {"default": []} | Running targets arguments, e.g. `{"targetName": ["args", "..."]}` |
+| **xmake.debuggingTargetsArguments** | object | {"default": []} | Debugging targets arguments |
+| **xmake.debugConfigType** | string | "default" | Debug configuration type: `default`, `codelldb`, `lldb-dap`, `gdb-dap` |
+| **xmake.customDebugConfig** | object | {} | Custom debugging configurations |
+| **xmake.envBehaviour** | string | "merge" | Environment behaviour: `erase`, `merge`, `override` |
+| **xmake.enableSyntaxCheck** | boolean | true | Enable Lua syntax check |
+
+## XMake Explorer
+
+The extension provides a dedicated XMake Explorer in the Activity Bar for project management:
+
+![XMake Explorer](https://raw.githubusercontent.com/tboox/xmake-vscode/master/res/explorer.png)
+
+### Features
+
+* **Project Overview**: View all targets and their configurations
+* **Target Management**: Build, rebuild, clean, run, and debug individual targets
+* **Configuration Panel**: Quick access to platform, architecture, mode, and toolchain settings
+* **Context Menu**: Right-click actions for quick operations
+
+### Explorer Actions
+
+- **Build All**: Build all targets in the project
+- **Rebuild All**: Clean and build all targets
+- **Clean All**: Clean all build artifacts
+- **Run All**: Run all executable targets
+- **Configure**: Open configuration settings
+
+## Available Commands
+
+Access all XMake commands through the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`):
+
+### Project Commands
+- **XMake: CreateProject**: Create a new XMake project
+- **XMake: NewFiles**: Add new files to the project
+- **XMake: Show Explorer**: Show/hide the XMake Explorer
+
+### Configuration Commands
+- **XMake: Configure**: Configure the project
+- **XMake: Clean Configure**: Clean and reconfigure the project
+- **XMake: Set Target Platform**: Set the target platform
+- **XMake: Set Target Architecture**: Set the target architecture
+- **XMake: Set Build Mode**: Set the build mode (debug/release)
+- **XMake: Set Default Target**: Set the default target
+- **XMake: toolchain**: Set the toolchain
+
+### Build Commands
+- **XMake: Build**: Build the current target
+- **XMake: BuildAll**: Build all targets
+- **XMake: Rebuild**: Rebuild the current target
+- **XMake: Clean**: Clean the current target
+- **XMake: CleanAll**: Clean all targets
+
+### Run and Debug Commands
+- **XMake: Run**: Run the current target
+- **XMake: BuildRun**: Build and run the target
+- **XMake: Debug**: Start debugging
+- **XMake: Launch Debug**: Launch with debugger
+
+### Package and Install Commands
+- **XMake: Package**: Package the project
+- **XMake: Install**: Install the project
+- **XMake: Uninstall**: Uninstall the project
+
+### Utility Commands
+- **XMake: BeginMacro**: Start recording commands
+- **XMake: EndMacro**: Stop recording commands
+- **XMake: RunMacro**: Run recorded macro
+- **XMake: RunLastCommand**: Repeat the last command
+- **XMake: UpdateIntellisense**: Update IntelliSense configuration
+
+## Task Integration
+
+The extension supports VS Code tasks for XMake operations. Create a `.vscode/tasks.json` file:
+
+```json
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "XMake: Build",
+            "type": "xmake",
+            "task": "build",
+            "problemMatcher": ["$gcc"],
+            "group": {
+                "kind": "build",
+                "isDefault": true
             }
+        },
+        {
+            "label": "XMake: Clean",
+            "type": "xmake",
+            "task": "clean",
+            "problemMatcher": []
+        },
+        {
+            "label": "XMake: Run",
+            "type": "xmake",
+            "task": "run",
+            "problemMatcher": []
         }
-    }
+    ]
 }
 ```
 
+### Available Task Types
+
+- `build`: Build the project
+- `clean`: Clean build artifacts
+- `run`: Run the target
+- `package`: Package the project
+- `install`: Install the project
+- `configure`: Configure the project
+
+## Key Bindings
+
+The extension provides the following default key bindings:
+
+| Key | Command | Description |
+|-----|---------|-------------|
+| `F5` | `xmake.onDebug` | Start debugging (when xmake is enabled) |
+
+You can customize these key bindings in VS Code preferences.
+
+## Platform-Specific Configuration
+
+The extension supports platform-specific configuration. You can use platform prefixes in your settings:
+
+```json
+{
+    "xmake.executable": "xmake",
+    "windows.xmake.executable": "xmake.exe",
+    "linux.xmake.executable": "/usr/bin/xmake",
+    "osx.xmake.executable": "/usr/local/bin/xmake"
+}
+```
+
+Supported platform prefixes:
+- `windows` for Windows
+- `linux` for Linux  
+- `osx` for macOS
+
+## Troubleshooting
+
+### Common Issues
+
+**XMake not found**
+- Ensure XMake is installed and accessible in your system PATH
+- Use `xmake.executable` setting to specify the full path to xmake executable
+
+**IntelliSense not working**
+- Run `XMake: UpdateIntellisense` command to generate `compile_commands.json`
+- Ensure your `.vscode/c_cpp_properties.json` references the correct compile commands file
+- Check that the C/C++ extension is installed and enabled
+
+**Debugging not working**
+- Verify your `launch.json` configuration has the correct target name
+- Check that the debugger extension (C/C++ or CodeLLDB) is installed
+- Ensure the debug configuration type matches your debugger extension
+
+**Build fails**
+- Check the output panel for detailed error messages
+- Verify your `xmake.lua` configuration is correct
+- Ensure all required dependencies and tools are installed
+
+### Getting Help
+
+- **Documentation**: [XMake Official Documentation](https://xmake.io)
+- **Issues**: [GitHub Issues](https://github.com/xmake-io/xmake-vscode/issues)
+- **Community**: 
+  - [Reddit](https://www.reddit.com/r/xmake/)
+  - [Discord](https://discord.gg/xmake)
+  - [Telegram](https://t.me/tbooxorg)
+  - [QQ Group](https://jq.qq.com/?_wv=1027&k=5hpwWFv)
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## Donation
+
+If you find this extension helpful, consider supporting the project:
+
+[![Donate](https://img.shields.io/badge/donate-us-orange.svg?style=flat-square)](https://xmake.io/about/sponsor.html)
+
