浏览代码

modify README & add icon

littleheuer 4 年之前
父节点
当前提交
5424f66b29
共有 4 个文件被更改,包括 22 次插入3 次删除
  1. 17 0
      README.md
  2. 3 3
      src/main/resources/META-INF/plugin.xml
  3. 1 0
      src/main/resources/icons/update.svg
  4. 1 0
      src/main/resources/icons/update_dark.svg

+ 17 - 0
README.md

@@ -62,6 +62,8 @@ Please see [xmake-github](https://github.com/xmake-io/xmake) and [website](http:
 * Tool windows
 * Build and run
 * Parse errors and goto file
+* C/C++ intellisense
+* Debug
  
 ## Quickstart
 
@@ -98,6 +100,21 @@ Please see [xmake-github](https://github.com/xmake-io/xmake) and [website](http:
 <div align="center">
 <img src="https://raw.githubusercontent.com/tboox/xmake-idea/master/res/menu.png" width="80%" />
 </div>
+
+## C/C++ intellisense
+> Only support CLion (>= 2020.1)
+
+1. Click "Update compile commands" to create or update "compile_commands.json" file
+2. Click "File > open..." to choose this file.
+
+## Debug
+> Only support Clion (>= 2020.1)
+
+1. Click "Update CmakeLists" to create or update "CmakeLists.txt" file.
+2. Click "File > open..." to choose this file.
+3. Choose "Run > Debug..." or "Run > Debug 'project name'" into debug mode.
+
+
  
 
   

+ 3 - 3
src/main/resources/META-INF/plugin.xml

@@ -146,11 +146,11 @@
             <action id="XMake.QuickStart" class="io.xmake.actions.QuickStartAction" text="Quick Start"
                     icon="/icons/quickstart.png" description="Quick start a new project."/>
             <action id="XMake.UpdateCmakeLists" class="io.xmake.actions.UpdateCmakeListsAction" text="Update CmakeLists"
-                    description="Create or update the CmakeLists.txt.">
-                <keyboard-shortcut keymap="$default" first-keystroke="ctrl U" second-keystroke="ctrl alt U"/>
+                    icon="/icons/update.svg" description="Create or update the CmakeLists.txt.">
+                <keyboard-shortcut keymap="$default" first-keystroke="alt U" />
             </action>
             <action id="XMake.UpdateCompileCommands" class="io.xmake.actions.UpdateCompileCommandsAction"
-                    text="Update Compile Commands" description="Create or update  compile_commands.js.">
+                    text="Update Compile Commands" icon="/icons/update.svg" description="Create or update  compile_commands.js.">
             </action>
         </group>
     </actions>

+ 1 - 0
src/main/resources/icons/update.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1633010565389" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="1515" xmlns:xlink="http://www.w3.org/1999/xlink" width="16" height="16"><defs><style type="text/css"></style></defs><path d="M896 432H606.506667l117.12-120.32c-116.48-115.413333-305.066667-119.68-421.546667-4.266667a293.333333 293.333333 0 0 0 0 417.706667c116.48 115.413333 305.066667 115.413333 421.546667 0 58.026667-57.6 87.04-124.373333 86.826666-208.853333H896c0 84.48-37.546667 194.133333-112.64 268.586666-149.76 148.266667-392.96 148.266667-542.72 0s-150.826667-388.693333-1.066667-536.96c149.546667-148.266667 390.186667-148.266667 539.733334 0L896 128v304zM533.333333 341.333333v181.333334l149.333334 88.746666-30.72 51.626667L469.333333 554.666667V341.333333h64z" p-id="1516" fill="#2c2c2c"></path></svg>

+ 1 - 0
src/main/resources/icons/update_dark.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1633009023186" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4025" xmlns:xlink="http://www.w3.org/1999/xlink" width="16" height="16"><defs><style type="text/css"></style></defs><path d="M896 432H606.506667l117.12-120.32c-116.48-115.413333-305.066667-119.68-421.546667-4.266667a293.333333 293.333333 0 0 0 0 417.706667c116.48 115.413333 305.066667 115.413333 421.546667 0 58.026667-57.6 87.04-124.373333 86.826666-208.853333H896c0 84.48-37.546667 194.133333-112.64 268.586666-149.76 148.266667-392.96 148.266667-542.72 0s-150.826667-388.693333-1.066667-536.96c149.546667-148.266667 390.186667-148.266667 539.733334 0L896 128v304zM533.333333 341.333333v181.333334l149.333334 88.746666-30.72 51.626667L469.333333 554.666667V341.333333h64z" p-id="4026" fill="#bfbfbf"></path></svg>