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-12-04 10:00:57 -05:00 committed by GitHub
parent c5d504067c
commit acee1552ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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
- <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.
- When prompted by VSCode, 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 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 <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.
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