alexwl/haskell-code-explorer
1
1
Fork 0
mirror of https://github.com/alexwl/haskell-code-explorer.git synced 2024-11-22 05:55:21 +03:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
alexwl 2019-04-26 12:11:45 +03:00
parent 6954dbf99e
commit 59e31e75d5
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,5 +1,7 @@
# Haskell Code Explorer
[![CircleCI](https://circleci.com/gh/alexwl/haskell-code-explorer/tree/master.svg?style=svg)](https://circleci.com/gh/alexwl/haskell-code-explorer/tree/master)
Haskell Code Explorer is a web application for exploring and understanding Haskell codebases. It provides IDE-like code intelligence features such as types and documentation on hover, "go to definition", "find references" and semantic highlighting.
Examples:
@ -117,11 +119,6 @@ Index package with specific `dist` directory:
haskell-code-indexer --package PATH --dist dist-newstyle/build/x86_64-linux/ghc-8.2.2/hpath-0.9.2
```
Index package built by Stack:
```bash
haskell-code-indexer --package PATH --dist $(stack path --dist-dir)
```
## Starting HTTP Server
`haskell-code-server` executable reads the package index created by `haskell-code-indexer` and starts the HTTP server. The HTTP server responds to API requests and serves static assets (JavaScript files that are in `haskell-code-explorer/javascript/release` directory).