From 297a8313875eb8fcb684d465bc0d7bf657b6f7d0 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Wed, 29 May 2019 22:28:22 -0700
Subject: [PATCH] ;site: symlink the main README.md, render it as part of the
 site

The top-level README.md is usually seen when browsing github or the
cloned source - not on the website - but now we render it as part of
the website to facilitate previewing it locally (with make
site-watch).

As a side effect of symlinking it into site/, it might override site/'s
README when browsing that directory on github.

[ci skip]
---
 Shake.hs       | 3 +--
 site/README    | 8 +++++++-
 site/README.md | 1 +
 3 files changed, 9 insertions(+), 3 deletions(-)
 create mode 120000 site/README.md

diff --git a/Shake.hs b/Shake.hs
index 71d2c6eb2..3090c7ef5 100755
--- a/Shake.hs
+++ b/Shake.hs
@@ -224,8 +224,7 @@ main = do
         ,"index"
         ,"intro"
         ,"release-notes"
-        -- some copied from elsewhere
-        -- ,"README"
+        ,"README"
         ,"CONTRIBUTING"
         ]
 
diff --git a/site/README b/site/README
index 192768f78..8564cb8fb 100644
--- a/site/README
+++ b/site/README
@@ -1,4 +1,10 @@
+This is the README for the site/ directory.
+
+(Confusingly, README.md from the parent directory is also symlinked
+here, to get it rendered as part of the website, and it might take
+precedence when viewing this dir on github.)
+
 Source files for the hledger.org website. 
-To render this, run ./Shake website. 
+To generate the website, run ./Shake website. 
 This will add the web manuals' markdown to this directory, 
 render all markdown as html, and copy static files, to site/_site/.
diff --git a/site/README.md b/site/README.md
new file mode 120000
index 000000000..32d46ee88
--- /dev/null
+++ b/site/README.md
@@ -0,0 +1 @@
+../README.md
\ No newline at end of file