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

Commit bfedd03

Browse files
authored
Merge pull request #92 from haskell/project-config-readme
Clarify difference between lsp and hie-bios configuration
2 parents 8e9bb3d + 58ac672 commit bfedd03

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

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

310-
## Explicit Configuration
310+
## Project Configuration
311311

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

314-
The user can place a `hie.yaml` file in the root of the workspace which
315-
describes how to setup the environment. For example, to explicitly state
316-
that you want to use `stack` then the configuration file would look like:
314+
HIE will attempt to automatically detect your project configuration and set up
315+
the environment for GHC.
316+
317+
| `cabal.project` | `stack.yaml` | `*.cabal` | Project selected |
318+
|-----------------|--------------|-----------|------------------|
319+
|| - | - | Cabal v2 |
320+
||| - | Stack |
321+
|||| Cabal (v2 or v1) |
322+
|||| None |
323+
324+
However, you can also place a `hie.yaml` file in the root of the workspace to
325+
**explicitly** describe how to setup the environment. For example, to state that
326+
you want to use `stack` then the configuration file would look like:
317327

318328
```yaml
319329
cradle:

0 commit comments

Comments
 (0)