From 612e84da1a18e2ad2c786199682b3a70e50a18d5 Mon Sep 17 00:00:00 2001
From: Sridhar Ratnakumar <3998+srid@users.noreply.github.com>
Date: Mon, 31 May 2021 19:37:01 -0400
Subject: [PATCH] Update README.md
---
README.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index ee89a5c..e8054d8 100644
--- a/README.md
+++ b/README.md
@@ -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
- 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.
-- Press Ctrl+Shift+B 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 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.
+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.