Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikolay.Obedin authored and Nikolay.Obedin committed Mar 20, 2015
1 parent 74c83e6 commit f3120fd
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SBT plugin for tweaking various IDE settings

This plugin provides several keys to be read by IDE while importing project.
Currently SBT 0.13 only.
SBT 0.13.5 and up.

## Usage

Expand All @@ -11,25 +11,30 @@ Currently SBT 0.13 only.
resolvers += Resolver.url("jetbrains-bintray",
url("http://dl.bintray.com/jetbrains/sbt-plugins/"))(Resolver.ivyStylePatterns)

addSbtPlugin("org.jetbrains" % "sbt-ide-settings" % "0.0-<sha-of-the-latest-commit>")
addSbtPlugin("org.jetbrains" % "sbt-ide-settings" % "<version>")
```

2. Tweak any settings you want

## Available settings

- `ideExportRunConfiguration`
- `ideExcludedDirectories`

Indicates whether run configuration of selected project should or should not be exported
List of directories to be marked as excluded in IDE.

- `ideExportTestConfiguration`
- `ideBasePackages`

Indicates whether test configuration of selected project should or should not be exported
List of packages to be used as base prefixes for chaining. Packages starting
with one of these prefixes will be chained automatically in IDE.

- `ideExcludedDirectories`
## Upcoming settings

Defines list of directories to be marked as excluded in IDE

- `ideBasePackages`
- `ideExportRunConfiguration`

Indicates whether run configuration of selected project should or should not
be exported

- `ideExportTestConfiguration`

Defines list of packages to be used as base prefixes for chaining. Packages starting with one of these prefixes will be chained automatically in IDE.
Indicates whether test configuration of selected project should or should not
be exported

0 comments on commit f3120fd

Please sign in to comment.