X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=README.md;h=17811a2468927418aa4b8608aaa902515a4b961c;hb=f917c4b4f3d79b320bdf8c3721a0c82507f9d93a;hp=8a16945bb5730b4f0be3d16c7755b411dd354c97;hpb=0f725228728dd6433fa0b94b28074c11a1d95a9d;p=lsp-test.git

diff --git a/README.md b/README.md
index 8a16945..17811a2 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# 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 [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test)
 lsp-test is a functional testing framework for Language Server Protocol servers.
 
 ```haskell
 import Language.Haskell.LSP.Test
-runSession "hie" fullCaps "proj/dir" $ do
+main = runSession "hie" fullCaps "proj/dir" $ do
   doc <- openDoc "Foo.hs" "haskell"
   skipMany anyNotification
   symbols <- getDocumentSymbols doc
@@ -34,15 +34,13 @@ count 4 (message :: Session ApplyWorkspaceEditRequest)
 anyRequest <|> anyResponse
 ```
 
-Try out the example tests in the `example` directory with `cabal new-test`.
+Try out the example tests in the `example` directory with `cabal test`.
 For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
 
 ## Developing
-The tests are integration tests, so make sure you have the following language servers installed and on your PATH:
-### [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
-- Check out a relatively recent version of the repo, or see `.travis.yml` to get the exact commit used for CI.
-- `stack install`
-### [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
-`npm i -g javascript-typescript-langserver`
-
-Then run the tests with `stack test` or `cabal new-test`.
+The tests for lsp-test use a dummy server found in `test/dummy-server/`.
+Run the tests with `cabal test` or `stack test`.
+Tip: If you want to filter the tests, use `cabal run test:tests -- -m "foo"`
+
+## Troubleshooting
+Seeing funny stuff when running lsp-test via stack? If your server is built upon Haskell tooling, [keep in mind that stack sets some environment variables related to GHC, and you may want to unset them.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)