Skip to content

Commit b73630b

Browse files
committed
docs(readme): add note about initial run
1 parent 0f424c9 commit b73630b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,19 @@ The following table summarizes the options:
198198
| Flymake integration ||||
199199
| Language Server Protocol (LSP) ||||
200200

201+
**Note:** when you run Elsa in a project for the first time, it is
202+
recommended to start it from the CLI because it will need to crawl all
203+
the dependencies you use and save the analysis results to cache files.
204+
This can take a couple of minutes if you have many dependencies (or if
205+
you include something like `org` which pulls in about 300 other
206+
packages).
207+
208+
After the results are cached, next time you need them Elsa can load
209+
them from cache and this is generally very fast.
210+
211+
You can start the LSP right away but it will be unresponsive during
212+
the time it is doing the initial analysis.
213+
201214
## Eask
202215

203216
### [RECOMMENDED] Using packaged version

0 commit comments

Comments
 (0)