From acee1552ed3d2ec396a3d5e582ad86994508cb13 Mon Sep 17 00:00:00 2001 From: Sridhar Ratnakumar <3998+srid@users.noreply.github.com> Date: Sat, 4 Dec 2021 10:00:57 -0500 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 844350b..be52147 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,28 @@ Haskell project template optimized for a fully reproducible and friendly develop ## Getting Started +First-time setup: + - [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 - - Ctrl+Shift+P to run command "Nix-Env: Select Environment" and select `shell.nix`. The extension will ask you to reload VSCode at the end. + - When prompted by VSCode, install the [workspace recommended](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) extensions + - Ctrl+Shift+P to run command "Nix-Env: Select Environment" and then select `shell.nix`. + - The extension will ask you to reload VSCode at the end. Do it. + +To run the program with auto-recompile: + - Press Ctrl+Shift+B 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. +Renaming the project: -Then, before using it for real, - -- Rename all occurrences of `haskell-template` to `myproject`, as well as rename the cabal file to `myproject.cabal`. - - To do this from commandline, run `nix run nixpkgs#sd -- haskell-template myproject * */*` -- Run `git add . && git commit -m rename` followed by `nix develop` (or `bin/run`) to verify that everything continues to work. +```sh +NAME=myproject +git mv haskell-template.cabal ${NAME}.cabal +nix run nixpkgs#sd -- haskell-template ${NAME} * */* +git add . && git commit -m rename +cd .. && mv haskell-template ${NAME} && cd ${NAME} +``` ## Tips