Skip to content

Commit

Permalink
add plugin description to README, which needed by gradle (#35)
Browse files Browse the repository at this point in the history
Signed-off-by: he1pa <[email protected]>
  • Loading branch information
He1pa authored Aug 1, 2024
1 parent 585b7ed commit be1c912
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# KCL Plugin for IntelliJ IDEA
<!-- Plugin description -->

<!-- This specific section of `Plugin description` is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
To keep everything working, do not remove `<!-- ... ->`
-->

The KCL IntelliJ IDEA plugin provides rich language support for the [KCL language](https://kcl-lang.io/).

In addition, we also have a plugin implemented based on the LSP(Language Server Protocol), which can be found [here](https://github.com/kcl-lang/intellij-kcl-lsp)

<!-- Plugin description end -->
## Quick Start

Welcome to KCL developing! We hope this plugin enhances your development experience with KCL.
Expand All @@ -26,7 +31,7 @@ This extension provides coding assistance such as basic syntax highlight, Intell

This extension provides baisc keywords completion

<!-- ### Code Formatting
### Code Formatting

Right click on the editor and select KCL Tools -> Format File to format current KCL file:

Expand All @@ -38,7 +43,7 @@ Right click on the target directory in the project structure panel, select KCL T

Right click on the project name in the project structure panel, select KCL Tools -> Format Project to format all files in the project:

<div style="text-align: center;"><img src="docs/img/format-project.png" alt="format project"></div> -->
<div style="text-align: center;"><img src="docs/img/format-project.png" alt="format project"></div>


## Ask for help
Expand Down

0 comments on commit be1c912

Please sign in to comment.