Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preamble - What do we mean when we say cabal? #5

Open
JonathanLorimer opened this issue Jun 26, 2021 · 2 comments
Open

Preamble - What do we mean when we say cabal? #5

JonathanLorimer opened this issue Jun 26, 2021 · 2 comments
Assignees
Labels
Good first issue Good for newcomers New Chapter Preamble Section label for introductory materials
Milestone

Comments

@JonathanLorimer
Copy link
Contributor

JonathanLorimer commented Jun 26, 2021

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

Resources

@JonathanLorimer JonathanLorimer added Preamble Section label for introductory materials New Chapter labels Jun 26, 2021
@JonathanLorimer JonathanLorimer added this to the Preamble V1 milestone Jun 26, 2021
@JonathanLorimer JonathanLorimer added the Good first issue Good for newcomers label Jul 1, 2021
@srirajshukla
Copy link

I'd like to read up more about cabal, and contribute to this section of the docs.

@JonathanLorimer
Copy link
Contributor Author

@srirajshukla Awesome! Its yours. Let me know if I can help you at all.

@JonathanLorimer JonathanLorimer moved this from To do to In progress in Cabal User Guide V1 Jul 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue Good for newcomers New Chapter Preamble Section label for introductory materials
Projects
Development

No branches or pull requests

2 participants