diff --git a/ijs.tree b/ijs.tree index b09df7b37..a238a8107 100644 --- a/ijs.tree +++ b/ijs.tree @@ -16,6 +16,7 @@ + @@ -23,7 +24,6 @@ - + +## Introduction + +This guide comes with a number of sample plugins available from dedicated [intellij-sdk-code-samples](https://github.com/JetBrains/intellij-sdk-code-samples) GitHub repository. + +Please see README.md which lists all available code samples with a short description. + +Each sample is stored in a dedicated folder and is accompanied by its own README.md. Links to the corresponding tutorial or reference page in this tutorial, as well as a list of relevant show-cased elements are provided. + +## Setting up Code Samples + +All sample plugins are based on Gradle, see [Building Plugins with Gradle](gradle_build_system.md) to get started. Additionally, the screencast [Working with Gradle in IntelliJ IDEA](https://www.youtube.com/watch?v=6V6G3RyxEMk) offers a thorough introduction to Gradle functionality. + +Make sure plugins _Git_, _Gradle_, and _Plugin DevKit_ are enabled. + +Clone the [intellij-sdk-code-samples](https://github.com/JetBrains/intellij-sdk-code-samples) GitHub repository via Git | Clone.... After successful cloning, the IDE suggests opening the project. + +Select the code sample(s) to import via the [Gradle tool window](https://www.jetbrains.com/help/idea/gradle.html#link_gradle_project). + +Alternatively, import _all_ code samples available by choosing `_gradleCompositeBuild`, which links all Gradle projects in a Composite Build. + +After successful import, the project appears in the Gradle tool window tree as a new node. + +## Running Code Samples + +Run the plugin by using the Gradle [runIde task](gradle_prerequisites.md#executing-the-plugin) shown under the corresponding project's Tasks node.