Skip to content

Commit

Permalink
Fix busted markdown, minor updates for current versions of everything
Browse files Browse the repository at this point in the history
  • Loading branch information
rholder committed Nov 22, 2017
1 parent 8dfdbbc commit eb77536
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
##What is this?
## What is this?
The Gradle View IntelliJ IDEA plugin shows a split tree rollup of the dependencies for each Gradle configuration in use
by a project.

##What is this?
Dependency wrangling isn't easy in a large Java project. This IntelliJ IDEA plugin was built to add a little more sanity
by a project. Dependency wrangling isn't easy in a large Java project. This IntelliJ IDEA plugin was built to add a little more sanity
to the tedious task of analyzing dependencies by rolling up the entire dependency graph into a pair of more easily
digestible trees derived from a serialized version of Gradle's dependency graph. The `Dependency List` provides a
lexicographically sorted set of all the dependencies for each configuration in your project and all of its sub-projects.
Expand All @@ -13,25 +10,25 @@ 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 1.12](http://www.gradle.org/docs/1.12/userguide/embedding.html), but should work on most 1.x and 2.x versions
## 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
* 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
* Toggle the showing of replaced dependencies

##Installation
## 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 1.12 in case you don't already have a cached copy available on your
need to download the embedded version of Gradle 3.5.1 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).

##Building from source
## Building from source
The Gradle View plugin 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.6+ for using the Gradle Wrapper bootstrap.
[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.
Expand All @@ -42,14 +39,14 @@ for details.
### add Gradle build variables
Create a custom `gradle.properties` file in the root directory and add a tooling version to use, as in:

gradleToolingApiVersion=1.12
gradleToolingApiVersion=3.5.1
ideaPluginJdkName=IDEA IU-135.690

The `ideaPluginJdkName` should be the version you have referenced in your IntelliJ IDE.

### compile, test and build plugin distribution zip
`./gradlew distPlugin`
`./gradlew clean distPlugin`

##License
## License
The Gradle View plugin is released under version 2.0 of the
[Apache License](http://www.apache.org/licenses/LICENSE-2.0). See LICENSE file for more details.

0 comments on commit eb77536

Please sign in to comment.