From 1e48637f07670bf51c7e86ce3b6100cebd128c5b Mon Sep 17 00:00:00 2001 From: Alexey Alekhin Date: Fri, 2 Feb 2018 03:55:05 +0100 Subject: [PATCH] Updated readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9542edd..00c47a6 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,17 @@ 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) @@ -24,4 +30,6 @@ apm install language-scala atom-ide-ui atom-sbt-client 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.