Fix HIE build instruction

[lsp-test.git] / README.md

diff --git a/README.md b/README.md
index 4a8762be7cf90bf11cb298fec70e1025362aed00..eb5250a8a36b512492ec3d597e1e115636370ca0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# haskell-lsp-test [![Build Status](https://travis-ci.com/Bubba/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/haskell-lsp-test)
-haskell-lsp-test is a functional testing framework for Language Server Protocol servers.
+# lsp-test [![Build Status](https://travis-ci.com/bubba/lsp-test.svg?branch=master)](https://travis-ci.com/bubba/lsp-test) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test-0.1.0.0)
+lsp-test is a functional testing framework for Language Server Protocol servers.
 
 ```haskell
 import Language.Haskell.LSP.Test
@@ -24,7 +24,7 @@ describe "diagnostics" $
 
 ### Replaying captured session
 ```haskell
-replaySession "hie --lsp" "test/data/renamePass"
+replaySession "hie" "test/data/renamePass"
 ```
 
 ### Parsing with combinators
@@ -34,9 +34,21 @@ count 4 (message :: Session ApplyWorkspaceEditRequest)
 anyRequest <|> anyResponse
 ```
 
-For more examples check the [Wiki](https://github.com/Bubba/haskell-lsp-test/wiki/Introduction)
+Try out the example tests in the `example` directory with `cabal new-test`.
+For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
 
 ## Developing
 To test make sure you have the following language servers installed:
 - [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
 - [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
+
+## How to run tests
+
+The present tests are integration tests. Thus, it is required that that the executables `hie` and `javascript-typescript-langserver` are on the path.
+
+The executable `hie` has to have been built using GHC 8.6.2. This can be done by cloning [Haskell-IDE-Engine](https://github.com/haskell/haskell-ide-engine) and invoking `stack install.hs hie-8.6.2`. This will create the executables `hie`, `hie-8.6` and `hie-8.6.2` in your `$HOME/.local/bin`, or respective `stack path --local-bin` location.
+To make sure the test environment is identical to the travis setup, in `.travis.yml` you can find the exact git hash that has been used to execute the tests and build `hie` from that snapshot.
+
+The language server `javascript-typescript-langserver` can be installed by invoking `npm i -g javascript-typescript-langserver`.
+
+When all prerequisites have been met, the tests can be executed by running `stack test`.
\ No newline at end of file