README suggestions

[dhall-lang]

README suggestions

[Gabriella439]

Sounds good!

I think the main blind spot I had when writing the README was underestimating the value of the JSON/YAML conversion. I had always viewed that as a second-class workaround for the lack of a direct language binding and not a first-class solution to recommend to users. However, from reading your feedback it sounds like I should instead rebrand Dhall as an alternative to Jsonnet that's safer and supports other integrations, too

I also agree with the other feedback about how to market use cases and solve specific problems at the beginning of the tutorial. I'll put up a pull request soon updating the README that you can review

[jml]

Oh, also, "how to install dhall" instructions for common platforms (Linux, macOS, Windows).

[Gabriella439]

Alright, then I'll try to provide binary releases for various platforms, too

[Gabriella439]

@BatmanAoD: Yeah, I will update the README with instructions soon. Here's my rough first draft of what I'll add to the README:

In the short-term, here are a few ways to install the interpreter:

• Recommended: Install the Haskell package using Haskell's stack build tool
  • Instructions for installing stack here: https://haskellstack.org/
  • Then run: stack setup && stack install dhall
• Install the Haskell package using Haskell's cabal build tool:
  • You can obtain cabal from the minimal installer here: https://www.haskell.org/downloads
  • Then run: cabal update && cabal install dhall
• Installing the package using Nix
  • Instructions for installing Nix here: https://nixos.org/nix/download.html
  • nix-env --install --attr haskellPackages.dhall

Installation paths that I'd like to provide (or that others can contribute if they have time before I do):

• brew
  • Surprisingly, there is already a brew package for dhall-json, but not dhall:
    • https://github.com/Homebrew/homebrew-core/blob/master/Formula/dhall-json.rb
    • It should be easy to crib from the above derivation to provide support for dhall
• Debian package
  • I think this is just a matter of asking the Debian Haskell group to package it. They're pretty helpful
• Pre-built binaries hosted on the release page of this repository
• Try the Dhall interpreter in the browser (using ghcjs to compile to Javascript)

[BatmanAoD]

Indeed, after disabling my virus scanner I was able to install GHC and dhall.

[Gabriella439]

@errordeveloper: You're welcome! 🙂

[errordeveloper]

I have to say that your blog has a few pretty concrete stories, but that's a lot of reading... I'm intending to have a good look at the blog at some point.

[BatmanAoD]

@jml @Gabriel439 Forgive me for asking a stupid question, but it looks like the README still doesn't provide a link or any instructions for installing the command-line interpreter. It looks like maybe the dhall executable itself is part of dhall-lang/dhall-haskell, which at first I didn't even think to look at, since I am not (yet) a Haskell-er? But, unfortunately, as a non-Haskell-er, I'm not even sure how to build/install the standalone package. A little help, please?

[BatmanAoD]

Thank you!

I realize this isn't really something you can help with, but stack seems to have some issues on Windows with certain antirivus software (GHC won't be automatically installed due to a permissions issue, and after installing it manually, I ran into another permissions issue trying to do the actual install; some searching led me to a couple of threads that suggest antivirus is to blame). So unfortunately I'll have to put trying dhall on hold for now.

[Gabriella439]

@BatmanAoD: No problem! You can report the stack issue here if there's not already a related issue: https://github.com/commercialhaskell/stack/issues

[BatmanAoD]

Yep, there is one, but it's been closed since the antivirus-disabling solution seems to work for most people. So at some point I'll either try again on a VM or talk to IT about making a scanning exception for Stack. commercialhaskell/stack#1917

[Gabriella439]

@BatmanAoD: One other question: if there had been a binary executable to install would that have made things easier? In other words, would you not have had to disable the virus scanner?

[BatmanAoD]

I believe that would have worked fine; I don't typically experience this sort of problem, and I don't think I've ever seen it for Windows msi binaries or other "native" installers.

[BatmanAoD]

That will definitely be helpful!

[Gabriella439]

I will close this out as I believe most of the original suggestions have been addressed in some way. In particular, we now have a https://docs.dhall-lang.org/ which has a more comprehensive set of educational resources and the README links to that now.

[errordeveloper]

@Gabriel439 thanks for closing with an informative note!