Skip to content

Add README.md in install/ subproject #2324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2021
Merged

Add README.md in install/ subproject #2324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9592921
Add README.md in install/ subproject
Nov 2, 2021
597557f
Merge branch 'master' into sir4ur0n/doc/installDirectory
jneira Nov 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# hls-install

This directory contains the `hls-install` project, an Haskell Language Server installer.
It is used when [installing from sources](https://haskell-language-server.readthedocs.io/en/latest/installation.html#building).

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.

The rationale behind this choice is to keep the installer completely isolated from main HLS code: different dependencies, different builds, etc.