From 597eb0fa4906b05b86a1c35d69296076c10bf4ae Mon Sep 17 00:00:00 2001 From: janmasrovira Date: Tue, 20 Dec 2022 16:45:48 +0100 Subject: [PATCH] Refactor hie.yaml and add entry in the readme (#1672) --- .gitignore | 1 + README.org | 16 +++++++++++++--- hie.yaml => stack.hie.yaml | 0 3 files changed, 14 insertions(+), 3 deletions(-) rename hie.yaml => stack.hie.yaml (100%) diff --git a/.gitignore b/.gitignore index 9eec0bcdf..9e60f2cee 100644 --- a/.gitignore +++ b/.gitignore @@ -86,3 +86,4 @@ docs/**/*.md docs/org/README.org # Binary files (produced by `make check`) examples/milestone/HelloWorld/HelloWorld +hie.yaml diff --git a/README.org b/README.org index 1be6b2180..c33ff9762 100644 --- a/README.org +++ b/README.org @@ -164,6 +164,19 @@ 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. @@ -171,9 +184,6 @@ 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 diff --git a/hie.yaml b/stack.hie.yaml similarity index 100% rename from hie.yaml rename to stack.hie.yaml