Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Commit a79ec33

Browse files
committed
Clarify difference between lsp and hie-bios configuration
Do this by renaming explicit configuration to project configuration
1 parent cd0d1eb commit a79ec33

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ we talk to clients.__
3434
- [Install specific GHC Version](#install-specific-ghc-version)
3535
- [Multiple versions of HIE (optional)](#multiple-versions-of-hie-optional)
3636
- [Configuration](#configuration)
37-
- [Explicit Configuration](#explicit-configuration)
37+
- [Project Configuration](#project-configuration)
3838
- [Editor Integration](#editor-integration)
3939
- [Using HIE with VS Code](#using-hie-with-vs-code)
4040
- [Using VS Code with Nix](#using-vs-code-with-nix)
@@ -305,13 +305,16 @@ There are some settings that can be configured via a `settings.json` file:
305305
- VS Code: These settings will show up in the settings window
306306
- LanguageClient-neovim: Create this file in `$projectdir/.vim/settings.json` or set `g:LanguageClient_settingsPath`
307307

308-
## Explicit Configuration
308+
## Project Configuration
309309

310-
**For a full explanation of possible configuration, we refer to [hie-bios/README](https://github.com/mpickering/hie-bios/blob/master/README.md).**
310+
**For a full explanation of possible configurations, refer to [hie-bios/README](https://github.com/mpickering/hie-bios/blob/master/README.md).**
311311

312-
The user can place a `hie.yaml` file in the root of the workspace which
313-
describes how to setup the environment. For example, to explicitly state
314-
that you want to use `stack` then the configuration file would look like:
312+
HIE will attempt to automatically detect your project configuration and set up
313+
the environment for GHC.
314+
315+
However, you can also place a `hie.yaml` file in the root of the workspace to
316+
**explicitly** describe how to setup the environment. For example, to state that
317+
you want to use `stack` then the configuration file would look like:
315318

316319
```yaml
317320
cradle: {stack}

0 commit comments

Comments
 (0)