Updated readme
[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 Compile with
43 ```
44 stack build
45 ```
46 or
47 ```
48 stack build advent01
49 ```
50
51 Run with
52 ```
53 stack exec advent01
54 ```
55
56 If you want to pass in additional RTS parameters, do it like this:
57 ```
58 stack exec -- advent01 +RTS -K0 -RTS
59 ```
60
61 Run interactively with
62 ```
63 stack ghci advent01
64 ```
65
66 To profile, use
67 ```
68 stack build --executable-profiling --library-profiling --ghc-options="-fprof-auto -rtsopts"
69 ```
70 then run with
71 ```
72 stack exec -- advent01 +RTS -p -hy
73 ```
74 Generate the profile graph with
75 ```
76 stack exec hp2ps advent01.hp
77 ```
78
79 # Packages
80
81 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).
82
83 When you use a new package, use
84
85 ```
86 stack solver
87 ```
88 to see how the `stack.yaml` file needs to change, and
89 ```
90 stack solver --update-yaml
91 ```
92 to implement the changes.
93
94 # IHaskell
95
96 Install following the [IHaskell instructions](https://github.com/gibiansky/IHaskell).
97
98 Run it with
99
100 ```
101 stack exec jupyter -- notebook
102 ```
103
104 # Readme
105
106 Build this readme file wth
107 ```
108 pandoc -s README.md > README.html
109 ```
110
111 (Using the [Modest style](https://github.com/markdowncss/modest).)