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

Commit ceba58e

Browse files
authored
Merge pull request #66 from dragos/issue/improve-docs
Improve Getting Started documentation.
2 parents 87e183b + 526adfe commit ceba58e

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ out/
1111
*.log
1212
scala/server/ensimeServer-assembly*
1313
coursier
14+
.hydra

scala/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ If you find this useful, please file tickets and contribute fixes. I'm working o
1212

1313
If you can't contribute your time but would like to donate, please [donate to the Ensime project](http://ensime.org/sponsor/) instead. This plugin delegates to Ensime for most of its features.
1414

15+
# Setting up
16+
17+
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.
18+
19+
>Remember to regenerate this file everytime you change your build (adding/removing dependencies, compiler arguments, etc.).
20+
21+
If you already started Code, it should detect that a new `.ensime` file was created and pick up the project.
22+
1523
# Setting the JDK
1624

1725
The path to the Java Development Kit is searched in the following order:

0 commit comments

Comments
 (0)