Skip to content

Commit 781a4e2

Browse files
Julien Debonjneira
Julien Debon
andauthored
Add README.md in install/ subproject (#2324)
Closes #2309 Co-authored-by: Javier Neira <[email protected]>
1 parent d845f87 commit 781a4e2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

install/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# hls-install
2+
3+
This directory contains the `hls-install` project, an Haskell Language Server installer.
4+
It is used when [installing from sources](https://haskell-language-server.readthedocs.io/en/latest/installation.html#building).
5+
6+
Unlike other subdirectories (e.g. `hls-graph` or `ghcide`), this is not another package of the HLS project, but another project entirely (with another `stack.yaml`, another `cabal.project`, etc.). It just so happens to be in a subdirectory of HLS project for convenience, as this is tightly related to HLS.
7+
8+
The rationale behind this choice is to keep the installer completely isolated from main HLS code: different dependencies, different builds, etc.

0 commit comments

Comments
 (0)