Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Clarify "Building", remove "submodules" in README #1732

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,16 +226,13 @@ In addition make sure `hie.exe` is not running by closing your editor, otherwise
#### Download the source code

```bash
git clone https://github.com/haskell/haskell-ide-engine --recurse-submodules
git clone https://github.com/haskell/haskell-ide-engine
cd haskell-ide-engine
```

#### Building

Uses the [shake](https://shakebuild.com/) build system for predictable builds.

Note, on first invocation of the build script, a GHC is being installed for execution.
The GHC used for the `install.hs` can be adjusted in `shake.yaml` by using a different resolver.
Note, on first invocation of the build script, a GHC is installed for execution. If you'd like to use a specific version of GHC for the `install.hs`, you can adjust the resolver in the `install/shake.yaml` file, as this project's build uses the [shake](https://shakebuild.com/) build tool.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as this project's build uses the shake build tool.

That is not really the reason why that works, it works because it is a regular haskell project that just happens to use shake.


Available commands can be seen with:

Expand Down