Skip to content
This repository was archived by the owner on Jun 8, 2023. It is now read-only.

Commit e1c5cdd

Browse files
committed
Simpler getting started instructions
1 parent e125fa2 commit e1c5cdd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

scala/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ If you can't contribute your time but would like to donate, please [donate to th
1414

1515
# Setting up
1616

17+
> It only supports Scala 2.12 projects for the moment (it might work to some extent with 2.11 if you're not using macros)
18+
19+
tl;dr;
20+
21+
```
22+
// add sbt-ensime to your build or in global.sbt
23+
addSbtPlugin("org.ensime" % "sbt-ensime" % "2.5.1")
24+
25+
// then generate ensime configuration
26+
sbt ensimeConfig
27+
```
28+
1729
This extension is based on [Ensime](http://ensime.org), so you need to create an Ensime configuration file before you can use it. This file lists source directories, classpath entries and compiler arguments. If you have an Sbt project simply add the [sbt-ensime](http://ensime.org/build_tools/sbt/) plugin and follow the guide (other build tools are [supported](http://ensime.org/build_tools/)). Then just run `sbt ensimeConfig` and voilà! You're all set up.
1830

1931
>Remember to regenerate this file everytime you change your build (adding/removing dependencies, compiler arguments, etc.).

0 commit comments

Comments
 (0)