darkkirb/matrix-media-expanded
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add info about WSL in README

Browse source
This commit is contained in:
Sridhar Ratnakumar 2022-07-27 15:14:06 -04:00 committed by GitHub
parent 6fc5f77e32
commit 66ddecb166
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -1,6 +1,8 @@
# haskell-template
Get a Haskell development environment up and running quickly, as long as Nix is installed.
Get a Haskell development environment up and running quickly, as long as Nix is available on your system[^windows].
[^windows]: On Windows, you may install Nix [under WSL2](https://nixos.wiki/wiki/Nix_Installation_Guide#Windows_Subsystem_for_Linux_.28WSL.29) and use the [Remote - WSL extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) to connect from the native VSCode. This runs your project under Linux while providing a near-native development experience on Windows.
This repository is a Haskell project template that is optimized for a fully reproducible and friendly development environment. It is based on:
@ -14,7 +16,7 @@ This repository is a Haskell project template that is optimized for a fully repr
First-time setup:
- [Install Nix](https://nixos.org/download.html) (>= 2.8) & [enable Flakes](https://nixos.wiki/wiki/Flakes)
- [Install Nix](https://nixos.org/download.html) (>= 2.8) & [enable Flakes](https://nixos.wiki/wiki/Flakes) (Using Windows? See footnote[^windows])
- Run `nix develop -c haskell-language-server` to sanity check your environment
- [Open as single-folder workspace](https://code.visualstudio.com/docs/editor/workspaces#_singlefolder-workspaces) in Visual Studio Code
- When prompted by VSCode, install the [workspace recommended](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) extensions