Couple of typo fixes.
[advent-of-code-19.git] / README.md
1 ---
2 title: "Advent of Code 2019"
3 output: html_document
4 css: modest.css
5 ---
6 Code to solve the [Advent of Code](http://adventofcode.com/2019/) puzzles. This year, I'm using the puzzles to develop my skills in [Haskell](https://wiki.haskell.org/Haskell).
7
8 [Learn you a Haskell](http://learnyouahaskell.com/chapters), [Introduction to Haskell 98](https://www.haskell.org/tutorial/index.html), and [Hackage](https://hackage.haskell.org/) are good resources.
9
10 The [Stack documentation](https://docs.haskellstack.org/en/stable/README/) and [How I Start: Haskell](http://howistart.org/posts/haskell/1/) are good sources of using the tools.
11
12 # Toolchain
13
14 I'm using the basic Haskell Platform installation, together with `stack` to manage the packages and dependencies (install with
15 ```
16 $ sudo aptitude install haskell-platform haskell-stack
17 ```
18 ), then updgrade with
19 ```
20 stack upgrade --binary-only
21 ```
22 as the version in the Ubuntu repos is too old to work with current Haskell Stack package sets.
23 ##
24
25 ## Creating the repository and project
26 Create the repository as normal: create the project in Gitolite, clone it, and insert the `.gitignore` and `README.md` files.
27
28 There's just one package, with the code in sub-directories of the `src` directory. Each day will generate one (or more) entries in the `adventofcode17.cabal` file.
29
30 Create the basic `stack` project. This will create a new directory. Note that this new directory name can't have a hyphen-delimited word that's just digits, so the project will have to be `advent-of-code`
31
32 ```
33 stack new advent-of-code --bare simple
34 ```
35
36 Modify the `stack.yaml` file as needed, such as adding the `ghc-options` stanza.
37
38 ## Creating subsequent days
39
40 Each day lives in a separate directory within the `src` directory. It will also need it's own stanza in `advent-of-code.cabal`.
41
42 Stack configuration taken from https://github.com/mstksg/advent-of-code-2018
43
44 Compile with
45 ```
46 stack build
47 ```
48 or
49 ```
50 stack build advent01
51 ```
52
53 Run with
54 ```
55 stack exec advent01
56 ```
57
58 If you want to pass in additional RTS parameters, do it like this:
59 ```
60 stack exec -- advent01 +RTS -K0 -RTS
61 ```
62
63 Run interactively with
64 ```
65 stack ghci advent01
66 ```
67
68 To profile, use
69 ```
70 stack build --executable-profiling --library-profiling --ghc-options="-fprof-auto -rtsopts"
71 ```
72 then run with
73 ```
74 stack exec -- advent01 +RTS -p -hy
75 ```
76 Generate the profile graph with
77 ```
78 stack exec hp2ps advent01.hp
79 ```
80
81 # Packages
82
83 Stack is using the [14.16-lts resolver](https://www.stackage.org/lts-14.16) for packages, so make sure you read the [correct documentation for the packages included in it](https://www.stackage.org/lts-14.16/docs).
84
85 When you use a new package, use
86
87 ```
88 stack solver
89 ```
90 to see how the `stack.yaml` file needs to change, and
91 ```
92 stack solver --update-yaml
93 ```
94 to implement the changes.
95
96 # IHaskell
97
98 Install following the [IHaskell instructions](https://github.com/gibiansky/IHaskell).
99
100 Run it with
101
102 ```
103 stack exec jupyter -- notebook
104 ```
105
106 # Readme
107
108 Build this readme file wth
109 ```
110 pandoc -s README.md > README.html
111 ```
112
113 (Using the [Modest style](https://github.com/markdowncss/modest).)