diff options
| author | alexwl <alexey.a.kiryushin@gmail.com> | 2019-03-23 02:19:15 +0300 |
|---|---|---|
| committer | alexwl <alexey.a.kiryushin@gmail.com> | 2019-03-23 02:19:15 +0300 |
| commit | a70857114d8394ad693e515f7bb6fead6eb97514 (patch) | |
| tree | 26ead8ce590120f91d4ef42df58a137232e3b2e5 | |
| parent | b24d1456d03e86407c66ca623f79072ff54de362 (diff) | |
Update README
| -rw-r--r-- | README.md | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -90,6 +90,8 @@ stack --stack-yaml=stack-8.0.2.yaml install A package should be built using either cabal-install or stack before indexing (`cabal new-build`,`cabal build`, or `stack build` command should be executed). +The version of GHC used to build `haskell-code-indexer` must match the version of GHC used to build a package you are indexing (to find out the version of GHC try `ghc --version` or `stack exec ghc -- --version` command). + `haskell-code-indexer` requires globally installed GHC and cabal-install (`cabal`). The reason for this is that `haskell-code-indexer` uses `cabal-helper` library [https://hackage.haskell.org/package/cabal-helper](https://hackage.haskell.org/package/cabal-helper) to get package build information. `cabal-helper` builds (at runtime) an executable linked against a version of Cabal library that was used to configure the package. If there is no globally installed GHC on the system, then it is possible to use `stack exec` command ([https://docs.haskellstack.org/en/stable/GUIDE/#exec](https://docs.haskellstack.org/en/stable/GUIDE/#exec)) that adds a path to GHC binaries installed by Stack to `PATH` environment variable: |