| layout | order | title | site_nav_entry |
|---|---|---|---|
page |
1 |
Getting Started |
true |
Fantastic, and welcome!
ENSIME has a JVM process that indexes your dependencies and understands your source code using scalac and javac Abstract Syntax Trees.
It is important to realise that ENSIME is not an IDE, it is just one tool in a toolbox, following the UNIX philosophy of Do One Thing and Do It Well. ENSIME's thing is to understand your source code. You must also have:
- a build tool to compile your project and a
.ensimefile describing your project layout. To generate this file, see which build tools we support. - a text editor that is supported. To install the appropriate plugin, learn about which editors we support.
If things don't work as you expected, please read the Getting Help guide before asking for help.
If you're a Scala beginner, our Learning Scala section has some excellent resources for you, and will help you get set up with a basic project.
We are volunteers with our own priorities to improve ENSIME. Our approach to feature requests is "we will enthusiastically help you to implement or fix it". The ENSIME codebase is surprisingly easy to understand and you are invited to read our Contributing Guide and jump in.
Whether or not you can help with direct contributions, please consider sponsoring a developer.
All interactions in ENSIME are governed by the Typelevel Code of Conduct.