git.iko.soy/ghcide
on master help sign in
Point to the VSCode marketplace in the readme (#134)
833c18cMoritz Kiefer
README.md+20−8
compare with master
unifiedsplit
@@ -69,14 +69,8 @@ Once you have got `ghcide` working outside the editor, the next step is to pick
69
69
70### Using with VS Code
70### Using with VS Code
71
71
72−Install the VS code extension (see https://code.visualstudio.com/docs/setup/mac for details on adding `code` to your `$PATH`):
72+You can install the VSCode extension from the [VSCode
73−
73+marketplace](https://marketplace.visualstudio.com/items?itemName=DigitalAssetHoldingsLLC.ghcide).
74−1. `cd extension/`
75−2. `npm ci`
76−3. `npm run vscepackage`
77−4. `code --install-extension ghcide-0.0.1.vsix`
78−
79−Now opening a `.hs` file should work with `ghcide`.
80
74
81### Using with Emacs
75### Using with Emacs
82
76
@@ -171,6 +165,24 @@ Add this to your coc-settings.json (which you can edit with :CocConfig):
171Here's a nice article on setting up neovim and coc: [Vim and Haskell in
165Here's a nice article on setting up neovim and coc: [Vim and Haskell in
1722019](http://marco-lopes.com/articles/Vim-and-Haskell-in-2019/)
1662019](http://marco-lopes.com/articles/Vim-and-Haskell-in-2019/)
173
167
168+## Hacking on ghcide
169+
170+To build and work on `ghcide` itself, you can use Stack or cabal, e.g.,
171+running `stack test` will execute the test suite.
172+
173+### Building the extension
174+
175+For development, you can also the VSCode extension from this repository (see
176+https://code.visualstudio.com/docs/setup/mac for details on adding
177+`code` to your `$PATH`):
178+
179+1. `cd extension/`
180+2. `npm ci`
181+3. `npm run vscepackage`
182+4. `code --install-extension ghcide-0.0.1.vsix`
183+
184+Now opening a `.hs` file should work with `ghcide`.
185+
174## History and relationship to other Haskell IDE's
186## History and relationship to other Haskell IDE's
175
187
176The code behind `ghcide` was originally developed by [Digital Asset](https://digitalasset.com/) as part of the [DAML programming language](https://github.com/digital-asset/daml). DAML is a smart contract language targeting distributed-ledger runtimes, based on [GHC](https://www.haskell.org/ghc/) with custom language extensions. The DAML programming language has [an IDE](https://webide.daml.com/), and work was done to separate off a reusable Haskell-only IDE (what is now `ghcide`) which the [DAML IDE then builds upon](https://github.com/digital-asset/daml/tree/master/compiler/damlc). Since that time, there have been various [non-Digital Asset contributors](https://github.com/digital-asset/ghcide/graphs/contributors), in addition to continued investment by Digital Asset. All contributions require a [Contributor License Agreement](https://cla.digitalasset.com/digital-asset/ghcide) that states you license the code under the [Apache License](LICENSE).
188The code behind `ghcide` was originally developed by [Digital Asset](https://digitalasset.com/) as part of the [DAML programming language](https://github.com/digital-asset/daml). DAML is a smart contract language targeting distributed-ledger runtimes, based on [GHC](https://www.haskell.org/ghc/) with custom language extensions. The DAML programming language has [an IDE](https://webide.daml.com/), and work was done to separate off a reusable Haskell-only IDE (what is now `ghcide`) which the [DAML IDE then builds upon](https://github.com/digital-asset/daml/tree/master/compiler/damlc). Since that time, there have been various [non-Digital Asset contributors](https://github.com/digital-asset/ghcide/graphs/contributors), in addition to continued investment by Digital Asset. All contributions require a [Contributor License Agreement](https://cla.digitalasset.com/digital-asset/ghcide) that states you license the code under the [Apache License](LICENSE).