From 52431847d6317ec47915715ad48e828502d6dcc7 Mon Sep 17 00:00:00 2001
From: Robert Pearce <me@robertwpearce.com>
Date: Tue, 22 Sep 2020 21:55:39 -0400
Subject: [PATCH] update README; remove NZ things; don't list hlint as a tool

---
 README.md             | 39 +++++++++++++++++++++++++++++++++++++++
 generator/src/Main.hs |  3 +--
 nix/default.nix       |  1 -
 3 files changed, 40 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 015ba76..94ec554 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,42 @@
 [![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)
 
 [Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org/) template
+
+## Features
+tl;dr: `nix-build` will collect all your pinned dependencies, build your hakyll
+site, and output the built site in a `result/` directory. If you set up the
+[main GitHub Action](./.github/workflows/main.yml) with what it needs (your
+[cachix](https://cachix.org) cache, and your app needs a `CACHIX_SIGNING_KEY`
+secret), it will deploy your built site to a `gh-pages` branch.
+
+* Hakyll (see [the generator folder](./generator))
+  * Haskell `nix-shell` environment inside the `generator` folder through which
+    you can run `hakyll-site watch` and all other hakyll commands, including
+    the ability to run `ghci` and load haskell modules for testing
+  * Ability to patch hakyll via `hakyll.patch`
+  * Ability to provide nixpkgs overrides for packages whose versions need to
+    come from [hackage](https://hackage.haskell.org)
+  * RSS & Atom XML feed generation
+  * Sitemap generation
+  * Reasonable pandoc markdown customization to make it as close to GitHub's
+    style as possible
+  * `Slug.hs` module that makes nice URIs
+  * Many other opinionated general website setup features that should be very
+    helpful
+* Nix
+  * Pinned [nixpkgs](https://github.com/NixOS/nixpkgs), [niv](https://github.com/nmattia/niv),
+    and [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix)
+  * `nix-build` will build your site into a `result/` directory
+  * `nix-shell` in the root will give you a shell with the `tools` dependencies
+    in [./nix/default.nix](./nix/default.nix)
+  * `nix-shell` in [./generator](./generator) will give you a haskell shell with
+      your `hakyll-site` available, as well as `ghci`
+* Dev linting via [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix)
+  * [nix-linter](https://github.com/Synthetica9/nix-linter)
+  * [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
+  * [ormolu](https://github.com/tweag/ormolu)
+  * [shellcheck](https://github.com/koalaman/shellcheck)
+* Encourages dev use of [lorri](https://github.com/target/lorri)
+* Deployment through a [GitHub Actions](https://github.com/features/actions)
+  build with [cachix](https://cachix.org) and deploying to
+  [GitHub Pages](https://pages.github.com/) via a `gh-pages` branch
diff --git a/generator/src/Main.hs b/generator/src/Main.hs
index f9f4ddf..5bbef81 100644
--- a/generator/src/Main.hs
+++ b/generator/src/Main.hs
@@ -82,8 +82,7 @@ main = hakyllWith config $ do
     route idRoute
     compile $ do
       posts <- recentFirst =<< loadAll "posts/*"
-      nzPages <- loadAll "new-zealand/**"
-      let pages = posts <> nzPages
+      let pages = posts
           sitemapCtx =
             constField "root" root
               <> constField "siteName" siteName
diff --git a/nix/default.nix b/nix/default.nix
index 361254b..a235b38 100644
--- a/nix/default.nix
+++ b/nix/default.nix
@@ -22,7 +22,6 @@ in
         generator
         pkgs.niv
         pkgs.pre-commit
-        pre-commit-hooks.hlint
         pre-commit-hooks.nixpkgs-fmt
         pre-commit-hooks.ormolu
       ];