cabal-userguide
cabal-userguide copied to clipboard
haskell
A handy user guide for the Cabal build tool
This chapter contains the different meanings of the term cabal. Right now, I've just added the basic skeleton. I'll be adding more information about the topic.
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/new_to_cabal/02_cabal_repl.md ## Brief Summary In the [content discussion issue](https://github.com/haskell/cabal-userguide/issues/1#issuecomment-861943815) it was mentioned that the easiest way to show a new user how to use cabal is through...
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...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/01_refactoring_and_re-use.md ## Brief Summary The motivation for this chapter is to show ways that common blocks in `.cabal` files can be factored out using common stanzas. ##...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/06_uploading_package_to_hackage.md ## Brief Summary This (like haddocks #22) is another poorly documented area. This section should cover common considerations (versioning, globally unique names), the relevant metadata in...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/05_generating_documentation_with_haddock.md ## Brief Summary In my opinion this is a relatively undocumented aspect of cabal. I think that it can be very mysterious to beginners, it is...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/04_build_products_and_caching.md ## Brief Summary The motivation for this chapter is to reveal some of the internals of cabal. It shouldn't be a deep dive, but an explanation...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/03_first_cabal_benchmark.md ## Brief Summary The motivation for this section is to show new users how to benchmark the performance of their applications using cabal. ## Resources [Old...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/02_first_cabal_test-suite.md ## Brief Summary The motivation for this chapter is to show users how to setup a test suite in cabal, how to test their library, and...
file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/preamble/04_how_to_install_software_with_cabal-install.md ## Brief Summary This issue was added because of discussion on the initial content ideation issue (starting [here](https://github.com/haskell/cabal-userguide/issues/1#issuecomment-861881018)). This is an important subject, because users often...