diff options
author | alexwl <alexey.a.kiryushin@gmail.com> | 2019-02-26 23:33:40 +0300 |
---|---|---|
committer | alexwl <alexey.a.kiryushin@gmail.com> | 2019-02-26 23:33:40 +0300 |
commit | 16c67ff304d5f6b38a74873bf5465fdafc4ee623 (patch) | |
tree | 94132ff46bc6b0053ff84dfe25d9e24009cfd31e | |
parent | eddf2c825dee199de0e958857f0daf3d08a07532 (diff) |
Update README
-rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -28,6 +28,9 @@ Reading and understanding code is an essential part of the software development * Find references (cross-package) ![References](https://haskell-code-explorer.mfix.io/references.png) +* Search for Haskell functions, data and type constructors by name (in the current package / in all indexed packages) + ![Search](https://haskell-code-explorer.mfix.io/search.png) + * Type of each expression<br /> ![Expression](https://haskell-code-explorer.mfix.io/expressions.png)<br /> Select a piece of text to get the type of each Haskell expression inside the selection. @@ -135,4 +138,10 @@ Load multiple indexed packages and start the server: haskell-code-server --package PATH1 --package PATH2 --package PATH3 --port 8080 ``` +Load the indexed package and start the server, use Hoogle API (https://github.com/ndmitchell/hoogle/blob/3dbf68bfd701f942d3af2e6debb74a0a78cd392e/docs/API.md#json-api) to get documentation for functions and types defined in other packages (`haskell-code-server` makes requests to https://hoogle.haskell.org/): + +```bash +haskell-code-server --package PATH --port 8080 --use-hoogle-api +``` + Open [http://localhost:8080](http://localhost:8080) in a browser to explore source code of the package. |