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

Rename Shakefile.hs to install.hs #1044

Merged
merged 1 commit into from
Jan 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,12 @@ Uses the [shake](https://shakebuild.com/) build system for predictable builds.
The build script is platform independent and the only prerequisites are that `git` and `stack` are installed. The dependency on `make` and other linux specific commands has been dropped.

Note, on first invocation of the build script, a GHC is being installed for execution. However, if you build HIE for every GHC, no GHC is downloaded twice.
The GHC used for the `Shakefile.hs` can be adjusted in `shake.yaml` by using a different resolver.
The GHC used for the `install.hs` can be adjusted in `shake.yaml` by using a different resolver.

Available commands can be seen with:

```bash
stack ./Shakefile.hs help
stack ./install.hs help
```

Remember, this will take time to download a Stackage-LTS and an appropriate GHC. However, afterwards all commands should work as expected.
Expand All @@ -283,15 +283,15 @@ Remember, this will take time to download a Stackage-LTS and an appropriate GHC.
Install **Nightly** (and hoogle docs):

```bash
stack ./Shakefile.hs hie-8.6.3
stack ./Shakefile.hs build-doc-8.6.3
stack ./install.hs hie-8.6.3
stack ./install.hs build-doc-8.6.3
```

Install **LTS** (and hoogle docs):

```bash
stack ./Shakefile.hs hie-8.4.4
stack ./Shakefile.hs build-doc-8.4.4
stack ./install.hs hie-8.4.4
stack ./install.hs build-doc-8.4.4
```

#### Install *all* available GHC versions with Shake
Expand All @@ -305,7 +305,7 @@ This will:
* build local hoogle docs for each version

```bash
stack ./Shakefile.hs build-all
stack ./install.hs build-all
```

Then add
Expand Down
2 changes: 1 addition & 1 deletion Shakefile.hs → install.hs
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ helpMessage = do
let out = liftIO . putStrLn
out ""
out "Usage:"
out " stack Shakefile.hs <target>"
out " stack install.hs <target>"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@fendor I wonder if hardcoded filename should be replaced with something like argv[0]. I doubt this file would be renamed again anytime soon, but one less place to check is a good thing.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree, that would be better.
In the next 2 weeks I'd like to add various improvements to it.

out ""
out "Targets:"
out
Expand Down