haskell / haskell/cabal-userguide

New To Cabal - Initializing a cabal repo

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
New Chapter New To Cabal
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/new_to_cabal/04_initializing_a_cabal_repo.md

## Brief Summary

This chapter should give a new user all the information they need to start a cabal repo. It should cover manually initializing a repo , initializing with `cabal init --interactive`, and initializing with `cabal init`. The chapter should go into a brief introduction of the directory structure of a standard cabal package, but no go into so much depth as to explain the more complicated aspects (i.e. `Setup.hs`

## Prior Art

[Kowainik Blog section on init](https://kowainik.github.io/posts/2018-06-21-haskell-build-tools#cabal-init)

## Resources

[Old cabal user guide init section](https://cabal.readthedocs.io/en/3.4/getting-started.html#initializing-the-application)
[Old cabal user guide initialization explanation](https://cabal.readthedocs.io/en/3.4/developing-packages.html#quickstart)
[Source code for interactive init](https://github.com/haskell/cabal/blob/master/cabal-install/src/Distribution/Client/Init/Interactive/Command.hs)
[Source code for non-interactive init](https://github.com/haskell/cabal/blob/master/cabal-install/src/Distribution/Client/Init/NonInteractive/Command.hs)

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.