Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated installation instructions? #33

Open
konsumlamm opened this issue Aug 7, 2021 · 1 comment
Open

Outdated installation instructions? #33

konsumlamm opened this issue Aug 7, 2021 · 1 comment

Comments

@konsumlamm
Copy link

The package description says to cabal install the package and that that will explain how to add the :printHeap command. However, cabal install ghc-heap-view fails with current cabal, since the package provides no executable. Using cabal install --lib ghc-heap-view instead works (and installs the library globally), but it still doesn't provide instructions on how to add the :printHeap command. Manually adding the contents of the ghci file adds the command.

I suggest recommending the use of cabal install --lib and including the contents of the ghci file (only two lines of code) in the package description (and maybe also add a README.md that at least links to the Hackage page). Or maybe I'm missing something, but in any case, the installation instructions should be updated.

That being said, the package works very well for me, so thank you!

@nomeata
Copy link
Owner

nomeata commented Aug 9, 2021

The instructions are indeed from an old era where cabal worked differently.

I personally don’t use cabal install --lib, but rather

cabal install --env . --lib ghc-heap-view

to do it only locally, and then importing the ghci file manually.

But you are right, the README needs to be refined.

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

No branches or pull requests

2 participants