Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laughedelic committed Feb 2, 2018
1 parent cfd6c06 commit 1e48637
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,24 @@ It connects to a running sbt instance and communicates with it using [Language S

## Installation

You will also need the Atom IDE UI plugin. You can install both with
You can install it using Atom interface or by running this command:

```
apm install language-scala atom-ide-ui atom-sbt-client
apm install atom-sbt-client
```

On the first launch it will automatically install its dependencies if needed:
+ [language-scala](https://github.com/atom-community/language-scala) for basic Scala syntax highlighting
+ [atom-ide-ui](https://github.com/facebook-atom/atom-ide-ui) for the Atom IDE interface


## Usage

1. Go to a Scala project and launch sbt (`project/build.properties` should set sbt version to 1.1.0 or higher)
2. Open this project in Atom, open any Scala file and save it.

It should trigger compilation and if there are any errors, you should see them in the gutter and in the diagnostics panel.

Another feature is jump-to-definition, which works for _some_ types in the project.

Note that despite the debug logging in the sbt shell, you can still use it directly. It's just a normal sbt shell which additionally communicates with Atom.

0 comments on commit 1e48637

Please sign in to comment.