lspitzner / lspitzner/brittany

Unclear instructions in README how to build with stack

Open
#362 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
686
Forks
69
PR merge metrics
No merged PRs in 30d

Description

I'm trying to build brittany from master using stack, so I checked readme and it says to use:

stack install brittany # --resolver lts-16.31

which doesn't seem correct because obviously current version requires GHC 9.x. I also tried with latest nightly (nightly-2022-01-04) but it doesn't seem to fit as well:

Selected resolver: nightly-2022-01-04
Resolver 'nightly-2022-01-04' does not have all the packages to match your requirements.
    aeson version 1.5.6.0 found
        - brittany requires >=2.0.1 && <2.1
    butcher not found
        - brittany requires >=1.3.3 && <1.4
    data-tree-print not found
        - brittany requires >=0.1.0 && <0.2
    multistate not found
        - brittany requires >=0.8.0 && <0.9
    text version 1.2.4.1 found
        - brittany requires >=1.2.5 && <1.3
    Using package flags:
        - brittany: FlagName "pedantic" = False

Is actually brittany still intended to be built using any existing stack resolver? I know this is probably low priority stuff, but maybe it would be nice to have working stack.yaml to make it easier building brittany using stack, if possible?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the build instructions in README and inspect the project's Stack configuration and package constraints. Check whether an existing Stack resolver can satisfy the dependencies and record the supported build path. Done means the README instructions and stack.yaml, if applicable, describe a working Stack build or clearly state that no resolver is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.