Documentation: How to install and use clash?

[cliffordwolf]

I've installed git head of clash (see instructions at https://github.com/clash-lang/clash-compiler/wiki/Getting-started) and used stack install to install that version of clash in ~/.local/bin. I can use stack exec -- clash ... as indicated in the riscv-semantics README file, but that just informs me that -clash-inline-limit= is not a valid option. When I remove the option it complains about not finding GHC.TypeLits.Normalise. I think git head of clash is the wrong version...

Next I tried uncommenting the clash related packages in stack.yaml and running stack build. After that I can confirm with stack -v that stack exec -- clash ... in src/ will actually use the clash binary from .../riscv-semantics/.stack-work/install/..., but I still see the same clash: unrecognised flag: -clash-inline-limit=200 error message. (Using --clash-inline-limit=200 doesn't change anything.) When I omit the -clash-inline-limit=200 option then it seems to be working.

I think stack.yaml and README.md should be changed accordingly so that people can reproduce the clash stuff easily without having to play around with different versions of clash and different sets of clash command line options.