Skip to content
This repository has been 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

Conversation

chexxor
Copy link

@chexxor chexxor commented Apr 10, 2020

I had some confusion when following the install/build instructions. I think these changes might improve them. Let me know what you think.

#1731

@jneira
Copy link
Member

jneira commented Apr 10, 2020

Hi! The project has not submodules now but it had them for a long time. It is not probable (but possible) that it will need again and --recurse-submodules does not throw an error if there are not actual submodules.

Otoh as it is not probable and the instructions are shorter this way, i think we could merge it.

@fendor
Copy link
Collaborator

fendor commented Apr 10, 2020

Installation script executes git submodule update --init anyways, right? So, we are still future-proof in a way

README.md Outdated

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants