Updated README
authorNeil Smith <neil.git@njae.me.uk>
Mon, 2 Dec 2019 14:23:51 +0000 (14:23 +0000)
committerNeil Smith <neil.git@njae.me.uk>
Mon, 2 Dec 2019 14:23:51 +0000 (14:23 +0000)
README.html
README.md

index 4680985b3e88c2857a65071527aa1009c9f59821..16c04e174f38c644c32c3887b81db80a996b2aea 100644 (file)
 <pre><code>$ sudo aptitude install haskell-platform haskell-stack</code></pre>
 <p>), then updgrade with</p>
 <pre><code> stack upgrade --binary-only</code></pre>
-<p>as the version in the Ubuntu repos is too old to work with current Haskell Stack package sets. ##</p>
+<p>as the version in the Ubuntu repos is too old to work with current Haskell Stack package sets.</p>
 <h2 id="creating-the-repository-and-project">Creating the repository and project</h2>
 <p>Create the repository as normal: create the project in Gitolite, clone it, and insert the <code>.gitignore</code> and <code>README.md</code> files.</p>
-<p>There's just one package, with the code in sub-directories of the <code>src</code> directory. Each day will generate one (or more) entries in the <code>adventofcode17.cabal</code> file.</p>
+<p>There's one package per day, with the code for each package in sub-directories of the root directory.</p>
 <p>Create the basic <code>stack</code> 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 <code>advent-of-code</code></p>
 <pre><code>stack new advent-of-code --bare simple</code></pre>
 <p>Modify the <code>stack.yaml</code> file as needed, such as adding the <code>ghc-options</code> stanza.</p>
 <h2 id="creating-subsequent-days">Creating subsequent days</h2>
-<p>Each day lives in a separate directory within the <code>src</code> directory. It will also need it's own stanza in <code>advent-of-code.cabal</code>.</p>
+<p>Each day lives in a separate directory, with its own <code>package.yaml</code> file and code in the <code>src</code> directory. (I based this configuration from <a href="https://github.com/mstksg/advent-of-code-2018">mstksg's setup</a>.)</p>
 <p>Compile with</p>
 <pre><code>stack build</code></pre>
 <p>or</p>
 <p>to see how the <code>stack.yaml</code> file needs to change, and</p>
 <pre><code>stack solver --update-yaml</code></pre>
 <p>to implement the changes.</p>
-<h1 id="ihaskell">IHaskell</h1>
-<p>Install following the <a href="https://github.com/gibiansky/IHaskell">IHaskell instructions</a>.</p>
-<p>Run it with</p>
-<pre><code>stack exec jupyter -- notebook</code></pre>
 <h1 id="readme">Readme</h1>
 <p>Build this readme file wth</p>
 <pre><code>pandoc -s README.md &gt; README.html</code></pre>
index 4430c77d886bfae6ca59c787d11f96a4db3c2ec9..d5207a3c26d61f575b171688fbeab533d43b20ae 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,12 +20,11 @@ $ sudo aptitude install haskell-platform haskell-stack
  stack upgrade --binary-only
 ```
 as the version in the Ubuntu repos is too old to work with current Haskell Stack package sets.
-## 
 
 ## Creating the repository and project
 Create the repository as normal: create the project in Gitolite, clone it, and insert the `.gitignore` and `README.md` files.
 
-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.
+There's one package per day, with the code for each package in sub-directories of the root directory. 
 
 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`
 
@@ -37,9 +36,7 @@ Modify the `stack.yaml` file as needed, such as adding the `ghc-options` stanza.
 
 ## Creating subsequent days
 
-Each day lives in a separate directory within the `src` directory. It will also need it's own stanza in `advent-of-code.cabal`.
-
-Stack configuration taken from https://github.com/mstksg/advent-of-code-2018
+Each day lives in a separate directory, with its own `package.yaml` file and code in the `src` directory. (I based this configuration from [mstksg's setup](https://github.com/mstksg/advent-of-code-2018).)
 
 Compile with
 ```
@@ -93,16 +90,6 @@ stack solver --update-yaml
 ```
 to implement the changes.
 
-# IHaskell
-
-Install following the [IHaskell instructions](https://github.com/gibiansky/IHaskell).
-
-Run it with
-
-```
-stack exec jupyter -- notebook
-```
-
 # Readme
 
 Build this readme file wth