haskell / haskell/cabal-userguide

Preamble - What do we mean when we say cabal?

Open
#5 2 comments 2 reactions 1 assignee Claimed by @srirajshukla View on GitHub
Good first issue New Chapter Preamble
Dominant language
Nix
Stars
29
Forks
5
PR merge metrics
No merged PRs in 30d

Description

file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/preamble/01_what_do_we_mean_when_we_say_cabal.md

## Brief Summary

The purpose of this chapter is to clear up some of the ambiguity around the overloaded term "cabal". We at least want to cover these four terms:
- cabal-install - the cli
- Cabal - the hackage package
- cabal.project - The configuration file
- .cabal - The package specific configuration file

If there are other cabal related terms that might be confusing, this would be a good place to precisely define them, and distinguish them from other cabal related things.

## Prior Art

- [Kowainik Blog Post](https://kowainik.github.io/posts/2018-06-21-haskell-build-tools#cabal)
- [Haskell School Post](https://schooloffp.co/2020/08/17/whirlwind-tour-of-cabal-for-beginners.html#clarifying-terms)

## Resources

- [cabal-install](https://cabal.readthedocs.io/en/3.4/cabal-commands.html)
- [cabal cli](https://cabal.readthedocs.io/en/3.4/intro.html)
- [.cabal file](https://cabal.readthedocs.io/en/3.4/installing-packages.html#repository-specification)
- [cabal.project](https://cabal.readthedocs.io/en/3.4/cabal-project.html)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.