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

Update README.md

Browse source
This commit is contained in:
Sridhar Ratnakumar 2021-05-31 19:37:01 -04:00 committed by GitHub
parent b4233c4e6d
commit 612e84da1a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,17 +1,19 @@
# haskell-template
Haskell project template using Nix + Flakes + VSCode (HLS).
Haskell project template using Nix + Flakes + VSCode (HLS) + Relude.
## Hacking
To develop with full IDE support in Visual Studio Code, follow these steps:
## Getting Started
- [Install Nix](https://nixos.org/download.html) & [enable Flakes](https://nixos.wiki/wiki/Flakes)
- Run `nix-shell --run 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
- Install the [workspace recommended](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) extensions
- <kbd>Ctrl+Shift+P</kbd> to run command "Nix-Env: Select Environment" and select `shell.nix`. The extension will ask you to reload VSCode at the end.
- Press <kbd>Ctrl+Shift+B</kbd> in VSCode, or run `bin/run` (`bin/run-via-tmux` if you have tmux installed) in terminal, to launch the Ema dev server, and navigate to http://localhost:9010/
- Press <kbd>Ctrl+Shift+B</kbd> in VSCode, or run `bin/run` (`bin/run-via-tmux` if you have tmux installed) in terminal, to launch Ghcid running your program.
All but the final step need to be done only once.
Then, before using it for real,
- Rename `haskell-template` to `myproject` as well rename the cabal file to `myproject.cabal`.
- `git add . && git ci -m naming` followed `nix develop` (or `bin/run`) to verify.