matrix-media-expanded/README.md

# haskell-template

Haskell project template optimized for a fully reproducible and friendly development environment. Based on [Nix](https://notes.srid.ca/haskell-nix) + [Flakes](https://serokell.io/blog/practical-nix-flakes) + VSCode ([HLS](https://github.com/haskell/haskell-language-server)) + [Relude](https://github.com/kowainik/relude#relude).

## 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 Ghcid running your program.

All but the final step need to be done only once.

Then, before using it for real,

- Rename all occurrences of `haskell-template` to `myproject`, as well as rename the cabal file to `myproject.cabal`. 
- Run `git add . && git commit -m rename` followed by `nix develop` (or `bin/run`) to verify that everything continues to work.

## Other templates

Some related templates include,

- [Serokell's Flake template](https://github.com/serokell/templates/tree/master/haskell-cabal2nix)
  - [Same, but using haskell.nix](https://github.com/serokell/templates/pull/2)
init 2021-05-31 23:19:51 +00:00			`# haskell-template`

add links 2021-06-01 02:43:40 +00:00			`Haskell project template optimized for a fully reproducible and friendly development environment. Based on [Nix](https://notes.srid.ca/haskell-nix) + [Flakes](https://serokell.io/blog/practical-nix-flakes) + VSCode ([HLS](https://github.com/haskell/haskell-language-server)) + [Relude](https://github.com/kowainik/relude#relude).`
init 2021-05-31 23:19:51 +00:00
Update README.md 2021-05-31 23:37:01 +00:00			`## Getting Started`
init 2021-05-31 23:19:51 +00:00
			`- [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.
Update README.md 2021-05-31 23:37:01 +00:00			- 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.
init 2021-05-31 23:19:51 +00:00
			`All but the final step need to be done only once.`

Update README.md 2021-05-31 23:37:01 +00:00			`Then, before using it for real,`

Update README.md 2021-06-01 02:39:49 +00:00			- Rename all occurrences of `haskell-template` to `myproject`, as well as rename the cabal file to `myproject.cabal`.
Update README.md 2021-06-01 02:40:11 +00:00			- Run `git add . && git commit -m rename` followed by `nix develop` (or `bin/run`) to verify that everything continues to work.
Update README.md 2021-06-01 12:37:15 +00:00
			`## Other templates`

			`Some related templates include,`

Update README.md 2021-06-02 22:21:30 +00:00			`- [Serokell's Flake template](https://github.com/serokell/templates/tree/master/haskell-cabal2nix)`
			`- [Same, but using haskell.nix](https://github.com/serokell/templates/pull/2)`