Skip to content

Commit

Permalink
Merge pull request digital-asset#2 from digital-asset/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
cocreature authored Sep 10, 2019
2 parents 1c25462 + a1e8bea commit b8cdaaf
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# `ghcide`
# `ghcide` - A library for building Haskell IDE tooling

Note: `ghcide` was previously called `hie-core`.

Our vision is that you should build an IDE by combining:

Expand All @@ -25,8 +27,8 @@ There are more details about our approach [in this blog post](https://4ta.uk/p/s

First install the `ghcide` binary using `stack` or `cabal`, e.g.

1. `git clone https://github.com/digital-asset/daml.git`
2. `cd daml/compiler/ghcide`
1. `git clone https://github.com/digital-asset/ghcide.git`
2. `cd ghcide`
3. `cabal install` or `stack install` (and make sure `~/.local/bin` is on your `$PATH`)

It's important that `ghcide` is compiled with the same compiler you use to build your projects.
Expand Down

0 comments on commit b8cdaaf

Please sign in to comment.