on master help sign in
Point to the VSCode marketplace in the readme (#134)

* Point to the VSCode marketplace in the readme * Move instructions for building the VSCode extension to Hacking section

commit833c18c8761739c3b3d9fad5e261434ef57c1e65 authorMoritz Kiefer <moritz.kiefer@purelyfunctional.org> dateWed 25 Sep 2019, 15:25 (7 years ago) parent60ed687
1 file changed+20−8
README.md+20−8
README.md+20−8
@@ -69,14 +69,8 @@ Once you have got `ghcide` working outside the editor, the next step is to pick
6969
7070### Using with VS Code
7171
72−Install the VS code extension (see https://code.visualstudio.com/docs/setup/mac for details on adding `code` to your `$PATH`):
73−
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`.
72+You can install the VSCode extension from the [VSCode
73+marketplace](https://marketplace.visualstudio.com/items?itemName=DigitalAssetHoldingsLLC.ghcide).
8074
8175### Using with Emacs
8276
@@ -171,6 +165,24 @@ Add this to your coc-settings.json (which you can edit with :CocConfig):
171165Here's a nice article on setting up neovim and coc: [Vim and Haskell in
1721662019](http://marco-lopes.com/articles/Vim-and-Haskell-in-2019/)
173167
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+
174186## History and relationship to other Haskell IDE's
175187
176188The 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).