luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleanup README

This commit is contained in:
Johannes Rudolph 2017-10-23 16:14:18 +02:00
parent 05ee0e4f1d
commit 8d5e9d9015
1 changed files with 1 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -4,10 +4,6 @@
Visualize your project's dependencies.
## Preliminaries
The plugin works best with sbt >= 0.13.6. See the [compatibility notes](#compatibility-notes) to use this plugin with an older version of sbt.
## Usage Instructions
Since sbt-dependency-graph is an informational tool rather than one that changes your build, you will more than likely wish to
@ -20,8 +16,6 @@ addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.8.2")
To add the plugin only to a single project, put this line into `project/plugins.sbt` of your project, instead.
This plugin is an auto-plugin which will be automatically enabled starting from sbt 0.13.5.
## Main Tasks
* `dependencyTree`: Shows an ASCII tree representation of the project's dependencies
@ -66,20 +60,6 @@ dependencyDotFile := file("dependencies.dot") //render dot file to `./dependenci
* [#19]: There's an unfixed bug with graph generation for particular layouts. Workaround:
Use `dependency-tree` instead of `dependency-graph`.
* [#39]: When using sbt-dependency-graph with sbt < 0.13.6.
## Compatibility notes
* sbt < 0.13.6: The plugin will fall back on the old ivy report XML backend which suffers from [#39].
* sbt < 0.13.5: Old versions of sbt have no `AutoPlugin` support, you need to add
```scala
net.virtualvoid.sbt.graph.DependencyGraphSettings.graphSettings
```
to your `build.sbt` or (`~/.sbt/0.13/user.sbt` for global configuration) to enable the plugin.
* sbt <= 0.12.x: Old versions of sbt are not actively supported any more. Please use the old version from the [0.7 branch](https://github.com/jrudolph/sbt-dependency-graph/tree/0.7).
## License
@ -87,5 +67,4 @@ Published under the [Apache License 2.0](http://en.wikipedia.org/wiki/Apache_lic
[global plugin]: http://www.scala-sbt.org/0.13/tutorial/Using-Plugins.html#Global+plugins
[global build configuration]: http://www.scala-sbt.org/0.13/docs/Global-Settings.html
[#19]: https://github.com/jrudolph/sbt-dependency-graph/issues/19
[#39]: https://github.com/jrudolph/sbt-dependency-graph/issues/39
[#19]: https://github.com/jrudolph/sbt-dependency-graph/issues/19