Skip to content

Commit

Permalink
Refactor hie.yaml and add entry in the readme (#1672)
Browse files Browse the repository at this point in the history
  • Loading branch information
janmasrovira authored Dec 20, 2022
1 parent af63c36 commit 597eb0f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,4 @@ docs/**/*.md
docs/org/README.org
# Binary files (produced by `make check`)
examples/milestone/HelloWorld/HelloWorld
hie.yaml
16 changes: 13 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -164,16 +164,26 @@ juvix compile --target wasm HelloWorld.juvix
wasmer HelloWorld.wasm
#+end_src

** LSP support

We provide a sammple =hie.yaml= configuration file for both =cabal= and =stack=.

If you prefer =stack=, run:
#+begin_src shell
cp stack.hie.yaml hie.yaml
#+end_src
If you prefer =cabal=, run:
#+begin_src shell
cp cabal.hie.yaml hie.yaml
#+end_src

** Building the project with =cabal=

We recommend that contributors use the =stack= build tool with this project.

If you would prefer to use the =cabal= build tool instead then you must generate
the =juvix.cabal= file using [[https://github.com/sol/hpack][hpack]] before running =cabal build=.

To configure the Haskell LSP server to use =cabal= then replace =hie.yaml= with
=cabal.hie.yaml= in the root of the repostiory.

** The Juvix programming language

Juvix allows us to write programs with a high degree of assurance. The Juvix
Expand Down
File renamed without changes.

0 comments on commit 597eb0f

Please sign in to comment.