Skip to content

Commit

Permalink
fixup! Readme
Browse files Browse the repository at this point in the history
Co-authored-by: Ivan Gromakovskii <[email protected]>
  • Loading branch information
Sereja313 and gromakovsky authored Sep 25, 2024
1 parent deec471 commit 2df4817
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion haskell.nix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Haskell application and library templates for Buildkite, Gitlab or GitHub CI usi

3. If you're using `hpack` or `stack2cabal` in your project, make sure to uncomment the related lines in both `flake.nix` and pipeline configuration files. To avoid version mismatches, use `nix develop .#ci -c hpack` or `nix develop .#ci -c stack2cabal`.

4. You might want to add a [`weeder`](https://github.com/ocharles/weeder/) check to check for dead code in your application. To do this uncomment the related lines in both `flake.nix`(do not forget to uncomment `writeHieFiles = true;`) and pipeline configuration files, then copy `weeder.toml`(For more advanced setup, please refer to the [corresponding section](https://github.com/ocharles/weeder/?tab=readme-ov-file#calling-weederUsually) of the `weeder` README) to your repository. For a library, code is usually considered dead unless it is exported; such cases are already detected by GHC warnings, so no `weeder` is required.
4. You might want to add a [`weeder`](https://github.com/ocharles/weeder/) check to check for dead code in your application. To do this uncomment the related lines in both `flake.nix` (do not forget to uncomment `writeHieFiles = true;`) and pipeline configuration files, then copy `weeder.toml` (for more advanced setup, please refer to the [corresponding section](https://github.com/ocharles/weeder/?tab=readme-ov-file#calling-weederUsually) of the `weeder` README) to your repository. For a library, code is usually considered dead unless it is exported; such cases are already detected by GHC warnings, so no `weeder` is required.

5. Make sure to clean up your `flake.nix` and pipeline configuration files by removing any optional code that is left commented out.

Expand Down

0 comments on commit 2df4817

Please sign in to comment.