From c2e5ea395809cf560f27a3f075b2ece5afd361f5 Mon Sep 17 00:00:00 2001 From: Ray Holder Date: Tue, 19 Nov 2019 23:53:04 -0600 Subject: [PATCH] Update README.md for 4.0.0 release --- README.md | 52 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 35 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 33f24e1..6d25b2b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ omitted if it is explicitly being included). ![Gradle View](http://plugins.jetbrains.com/files/7150/screenshot_14710.png) ## Features - * Built on the [Gradle Tooling API 3.5.1](https://docs.gradle.org/3.5.1/userguide/embedding.html), but should work on most 1.x, 2.x, 3.x, and 4.x versions + * Built on the [Gradle Tooling API 5.6.2](https://docs.gradle.org/5.6.2/userguide/embedding.html), but should work on other recent versions * Visual highlighting to indicate dependencies in use and replacement versions * Lexicographically sorted listing for all Gradle configurations * Load any project's Gradle dependencies, not just the one currently open inside IntelliJ @@ -20,32 +20,50 @@ omitted if it is explicitly being included). ## Installation The latest version of the Gradle View plugin is available on the [JetBrains Plugin Repository](http://plugins.jetbrains.com/). The first time you interact with Gradle View, you may -need to download the embedded version of Gradle 3.5.1 in case you don't already have a cached copy available on your +need to download the embedded version of Gradle in case you don't already have a cached copy available on your workstation. This should be seamless, and the tool window title and log will indicate a download of this is in progress. -You may also build and install the plugin from source (see below). + +The IntelliJ plugin zip and a standalone jar release are available [here](https://github.com/rholder/gradle-view/releases). +The standalone jar can be run without IntelliJ. You may also build and install the plugin from source (see below). ## Building from source -The Gradle View plugin uses a [Gradle](http://gradle.org)-based build system. In the instructions +This repository has everything needed to set up the development environment to build this plugin from source. + +The Gradle View plugin itself uses a [Gradle](http://gradle.org)-based build system. In the instructions below, [`./gradlew`](http://vimeo.com/34436402) is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build. The prerequisites are -[Git](https://help.github.com/articles/set-up-git) and JDK 1.7+ for using the Gradle Wrapper bootstrap. -You'll also need the IntelliJ IDEA SDK installed in your IntelliJ environment. See -[Configuring IntelliJ IDEA SDK](http://confluence.jetbrains.net/display/IDEADEV/Getting+Started+with+Plugin+Development) -for details. +[Git](https://help.github.com/articles/set-up-git) and JDK 1.8+ for using the Gradle Wrapper bootstrap. -### check out sources -`git clone git://github.com/rholder/gradle-view.git` +More information about the IntelliJ IDEA plugin development process can be found +[here](https://www.jetbrains.org/intellij/sdk/docs/tutorials/build_system/gradle_guide.html#overview-of-the-intellij-idea-gradle-plugin), +but the following are some bare bones testing and development instructions: -### add Gradle build variables -Create a custom `gradle.properties` file in the root directory and add a tooling version to use, as in: +#### Check out sources +Check out this repository locally with: +```bash +git clone git://github.com/rholder/gradle-view.git +``` - gradleToolingApiVersion=3.5.1 - ideaPluginJdkName=IDEA IU-135.690 +#### Adjust Gradle build variables +Review the contents of the `gradle.properties` file in the root directory and update them if desired. -The `ideaPluginJdkName` should be the version you have referenced in your IntelliJ IDE. +#### Compile and build plugin distribution zip +Run the following to create an installable plugin zip in `build/distributions/gradle-view-*.zip`: +```bash +./gradlew clean distPlugin +``` +[Install the plugin from disk](https://www.jetbrains.com/help/idea/managing-plugins.html) with `Settings/Preferences` -> `Plugins` -> `(Gear Icon)` -> `Install Plugin from Disk`. -### compile, test and build plugin distribution zip -`./gradlew clean distPlugin` +#### Compile and build a standalone jar +A standalone Swing version that doesn't depend on IntelliJ can be built with: +```bash +./gradlew clean distStandalone +``` +This jar can then be run with: +```bash +java -jar build/distributions/gradle-view-standalone.jar +``` +NOTE: This is not the same as the IntelliJ platform plugin zip. It cannot be installed in the IDE. ## License The Gradle View plugin is released under version 2.0 of the