Add skeleton based on proposed content outline (#3)

JonathanLorimer · web-flow · commit d2d40e70b88c · 2021-06-23T18:04:38.000-04:00
* chore: remove generated files

* feat: fill out SUMMARY.md

* feat: generate chapter files

* feat: add cabal env chapter
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,3 +1,51 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+# Preamble
+
+- [What do we mean when we say cabal?](./preamble/01_what_do_we_mean_when_we_say_cabal.md) (`cabal-install`, `Cabal`, `cabal.project`, and `.cabal` files)
+- [What is a module and a package?](./preamble/02_what_is_a_module_and_a_package.md)
+- [What is hackage?](./preamble/03_what_is_hackage.md)
+- [How to install software with cabal-install](./preamble/04_how_to_install_software_with_cabal-install.md)
+
+# New To Cabal
+
+- [Installing cabal + GHC](./new_to_cabal/01_installing_cabal_and_ghc.md)
+- [Cabal repl](./new_to_cabal/02_cabal_repl.md)
+- [Cabal env](./new_to_cabal/03_cabal_env.md)
+- [Initializing a cabal repo](./new_to_cabal/04_initializing_a_cabal_repo.md)
+- [Basic package properties](./new_to_cabal/05_basic_package_properties.md)
+- [First cabal library](./new_to_cabal/06_first_cabal_library.md)
+- [First cabal executable](./new_to_cabal/07_first_cabal_executable.md)
+- [Combining a library and an executable](./new_to_cabal/08_combining_a_library_and_an_executable.md)
+- [Adding dependencies](./new_to_cabal/09_adding_dependencies.md)
+- [Running your code](./new_to_cabal/10_running_your_code.md)
+
+# Leveling Up
+
+- [Refactoring and re-use](./leveling_up/01_refactoring_and_re-use.md)
+- [First cabal test-suite](./leveling_up/02_first_cabal_test-suite.md)
+- [First cabal benchmark](./leveling_up/03_first_cabal_benchmark.md)
+- [Build products and caching](./leveling_up/04_build_products_and_caching.md)
+- [Generating documentation with haddock](./leveling_up/05_generating_documentation_with_haddock.md)
+- [Uploading package to hackage](./leveling_up/06_uploading_package_to_hackage.md)
+
+# Getting Fancy
+
+- [Setting up a cabal project](./getting_fancy/01_setting_up_a_cabal_project.md)
+- [Adding doctests](./getting_fancy/02_adding_doctests.md)
+- [Adding local hoogle](./getting_fancy/03_adding_local_hoogle.md)
+- [Flags and conditionals](./getting_fancy/04_flags_and_conditionals.md)
+- [Profiling](./getting_fancy/05_profiling.md)
+- [Foreign libraries](./getting_fancy/06_foreign_libraries.md)
+- [Accessing data files](./getting_fancy/07_accessing_data_files.md)
+- [Hpack](./getting_fancy/08_hpack.md)
+- [Custom Setup](./getting_fancy/09_custom_setup.md)
+- [Backpack](./getting_fancy/10_backpack.md)
+- [Nix Interop](./getting_fancy/11_nix_interop.md)
+
+# Appendices
+
+- [Stack vs cabal](./appendices/01_stack_vs_cabal.md)
+- [Static builds](./appendices/02_static_builds.md)
+- [Cabal in CI](./appendices/03_cabal_in_ci.md)
+- [Transitioning from v1 to v2](./appendices/04_transitioning_from_v1_to_v2.md)
diff --git a/src/appendices/01_stack_vs_cabal.md b/src/appendices/01_stack_vs_cabal.md
@@ -0,0 +1 @@
+# Stack vs cabal
diff --git a/src/appendices/02_static_builds.md b/src/appendices/02_static_builds.md
@@ -0,0 +1 @@
+# Static builds
diff --git a/src/appendices/03_cabal_in_ci.md b/src/appendices/03_cabal_in_ci.md
@@ -0,0 +1 @@
+# Cabal in CI
diff --git a/src/appendices/04_transitioning_from_v1_to_v2.md b/src/appendices/04_transitioning_from_v1_to_v2.md
@@ -0,0 +1 @@
+# Transitioning from v1 to v2
diff --git a/src/chapter_1.md b/src/chapter_1.md
diff --git a/src/getting_fancy/01_setting_up_a_cabal_project.md b/src/getting_fancy/01_setting_up_a_cabal_project.md
@@ -0,0 +1 @@
+# Setting up a cabal project
diff --git a/src/getting_fancy/02_adding_doctests.md b/src/getting_fancy/02_adding_doctests.md
@@ -0,0 +1 @@
+# Adding doctests
diff --git a/src/getting_fancy/03_adding_local_hoogle.md b/src/getting_fancy/03_adding_local_hoogle.md
@@ -0,0 +1 @@
+# Adding local hoogle
diff --git a/src/getting_fancy/04_flags_and_conditionals.md b/src/getting_fancy/04_flags_and_conditionals.md
@@ -0,0 +1 @@
+# Flags and conditionals
diff --git a/src/getting_fancy/05_profiling.md b/src/getting_fancy/05_profiling.md
@@ -0,0 +1 @@
+# Profiling
diff --git a/src/getting_fancy/06_foreign_libraries.md b/src/getting_fancy/06_foreign_libraries.md
@@ -0,0 +1 @@
+# Foreign libraries
diff --git a/src/getting_fancy/07_accessing_data_files.md b/src/getting_fancy/07_accessing_data_files.md
@@ -0,0 +1 @@
+# Accessing data files
diff --git a/src/getting_fancy/08_hpack.md b/src/getting_fancy/08_hpack.md
@@ -0,0 +1 @@
+# Hpack
diff --git a/src/getting_fancy/09_custom_setup.md b/src/getting_fancy/09_custom_setup.md
@@ -0,0 +1 @@
+# Custom Setup
diff --git a/src/getting_fancy/10_backpack.md b/src/getting_fancy/10_backpack.md
@@ -0,0 +1 @@
+# Backpack
diff --git a/src/getting_fancy/11_nix_interop.md b/src/getting_fancy/11_nix_interop.md
@@ -0,0 +1 @@
+# Nix Interop
diff --git a/src/leveling_up/01_refactoring_and_re-use.md b/src/leveling_up/01_refactoring_and_re-use.md
@@ -0,0 +1 @@
+# Refactoring and re-use
diff --git a/src/leveling_up/02_first_cabal_test-suite.md b/src/leveling_up/02_first_cabal_test-suite.md
@@ -0,0 +1 @@
+# First cabal test-suite
diff --git a/src/leveling_up/03_first_cabal_benchmark.md b/src/leveling_up/03_first_cabal_benchmark.md
@@ -0,0 +1 @@
+# First cabal benchmark
diff --git a/src/leveling_up/04_build_products_and_caching.md b/src/leveling_up/04_build_products_and_caching.md
@@ -0,0 +1 @@
+# Build products and caching
diff --git a/src/leveling_up/05_generating_documentation_with_haddock.md b/src/leveling_up/05_generating_documentation_with_haddock.md
@@ -0,0 +1 @@
+# Generating documentation with haddock
diff --git a/src/leveling_up/06_uploading_package_to_hackage.md b/src/leveling_up/06_uploading_package_to_hackage.md
@@ -0,0 +1 @@
+# Uploading package to hackage
diff --git a/src/new_to_cabal/01_installing_cabal_and_ghc.md b/src/new_to_cabal/01_installing_cabal_and_ghc.md
@@ -0,0 +1 @@
+# Installing cabal + GHC
diff --git a/src/new_to_cabal/02_cabal_repl.md b/src/new_to_cabal/02_cabal_repl.md
@@ -0,0 +1 @@
+# Cabal repl
diff --git a/src/new_to_cabal/03_cabal_env.md b/src/new_to_cabal/03_cabal_env.md
@@ -0,0 +1 @@
+# Cabal env
diff --git a/src/new_to_cabal/03_initializing_a_cabal_repo.md b/src/new_to_cabal/03_initializing_a_cabal_repo.md
@@ -0,0 +1 @@
+# Initializing a cabal repo
diff --git a/src/new_to_cabal/04_basic_package_properties.md b/src/new_to_cabal/04_basic_package_properties.md
@@ -0,0 +1 @@
+# Basic package properties
diff --git a/src/new_to_cabal/04_initializing_a_cabal_repo.md b/src/new_to_cabal/04_initializing_a_cabal_repo.md
@@ -0,0 +1 @@
+# Initializing a cabal repo
diff --git a/src/new_to_cabal/05_basic_package_properties.md b/src/new_to_cabal/05_basic_package_properties.md
@@ -0,0 +1 @@
+# Basic package properties
diff --git a/src/new_to_cabal/05_first_cabal_library.md b/src/new_to_cabal/05_first_cabal_library.md
@@ -0,0 +1 @@
+# First cabal library
diff --git a/src/new_to_cabal/06_first_cabal_executable.md b/src/new_to_cabal/06_first_cabal_executable.md
@@ -0,0 +1 @@
+# First cabal executable
diff --git a/src/new_to_cabal/06_first_cabal_library.md b/src/new_to_cabal/06_first_cabal_library.md
@@ -0,0 +1 @@
+# First cabal library
diff --git a/src/new_to_cabal/07_combining_a_library_and_an_executable.md b/src/new_to_cabal/07_combining_a_library_and_an_executable.md
@@ -0,0 +1 @@
+# Combining a library and an executable
diff --git a/src/new_to_cabal/07_first_cabal_executable.md b/src/new_to_cabal/07_first_cabal_executable.md
@@ -0,0 +1 @@
+# First cabal executable
diff --git a/src/new_to_cabal/08_adding_dependencies.md b/src/new_to_cabal/08_adding_dependencies.md
@@ -0,0 +1 @@
+# Adding dependencies
diff --git a/src/new_to_cabal/08_combining_a_library_and_an_executable.md b/src/new_to_cabal/08_combining_a_library_and_an_executable.md
@@ -0,0 +1 @@
+# Combining a library and an executable
diff --git a/src/new_to_cabal/09_adding_dependencies.md b/src/new_to_cabal/09_adding_dependencies.md
@@ -0,0 +1 @@
+# Adding dependencies
diff --git a/src/new_to_cabal/09_running_your_code.md b/src/new_to_cabal/09_running_your_code.md
@@ -0,0 +1 @@
+# Running your code
diff --git a/src/new_to_cabal/10_running_your_code.md b/src/new_to_cabal/10_running_your_code.md
@@ -0,0 +1 @@
+# Running your code
diff --git a/src/preamble/01_what_do_we_mean_when_we_say_cabal.md b/src/preamble/01_what_do_we_mean_when_we_say_cabal.md
@@ -0,0 +1 @@
+# What do we mean when we say cabal?
diff --git a/src/preamble/02_what_is_a_module_and_a_package.md b/src/preamble/02_what_is_a_module_and_a_package.md
@@ -0,0 +1 @@
+# What is a module and a package?
diff --git a/src/preamble/03_what_is_hackage.md b/src/preamble/03_what_is_hackage.md
@@ -0,0 +1 @@
+# What is hackage?
diff --git a/src/preamble/04_how_to_install_software_with_cabal-install.md b/src/preamble/04_how_to_install_software_with_cabal-install.md
@@ -0,0 +1 @@
+# How to install software with cabal-install
