From 7ac149b49364a60fdc3d4eea9e3e7dacd25530e2 Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Thu, 13 Jul 2023 20:50:55 +0200
Subject: add DEVELOPMENT.md

---
 DEVELOPMENT.md | 38 ++++++++++++++++++++++++++++++++++++++
 README.md      | 25 ++++---------------------
 _config.yml    |  1 +
 3 files changed, 43 insertions(+), 21 deletions(-)
 create mode 100644 DEVELOPMENT.md

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 0000000..d57eb02
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,38 @@
+Workspace setup
+---------------
+
+* To reduce pain, set up [rbenv] to manage your Ruby versions.
+Install one that's known to work: `make ruby`
+    * Otherwise, make sure you have Ruby and [Bundler] set up.
+* Install dependencies: `make deps`
+* Make sure builds are working: `make build`
+
+[rbenv]: https://github.com/rbenv/rbenv
+[Bundler]: https://bundler.io/
+
+Development
+-----------
+
+* Build the example website and serve it at http://localhost:4000/:
+`make serve`
+    * It will pick up changes and reload pages automatically.
+
+Upgrading dependencies
+----------------------
+
+    bundle update
+
+Building static pages
+---------------------
+
+If you try to copy the _site directory and open index.html without running the
+web server, it won't work: all links will be messed up.
+Jekyll doesn't provide native support for generating a static website which can
+be browsed without running a web server.
+
+One workaround is to `wget` the website:
+
+    make serve LIVE_RELOAD=0    # Live reloading breaks wget
+    make wget
+
+The truly static version will be downloaded to the .wget/ directory.
diff --git a/README.md b/README.md
index 9dc9b2f..0ab76b3 100644
--- a/README.md
+++ b/README.md
@@ -5,32 +5,15 @@ Egor Tensin
 
 This is my website hosted at https://egort.name/.
 
-Development
------------
-
-This is a static website, generated using [Jekyll].
-
-Make sure you have Ruby and [Bundler] set up.
-[GNU Make] is used for shortcuts.
-
-* Install dependencies by running `make deps`.
-* Build the website by running `make build`.
-* Launch a local web server by running `make serve`.
-Access the website at http://localhost:4000/.
-
-[jekyll-theme] is used as a remote Jekyll theme.
+Built using [Jekyll]; uses [jekyll-theme] as the Jekyll theme.
 
 [Jekyll]: https://jekyllrb.com/
-[Bundler]: https://bundler.io/
-[GNU Make]: https://www.gnu.org/software/make/
 [jekyll-theme]: https://github.com/egor-tensin/jekyll-theme
 
-### Access via file://
+Development
+-----------
 
-Jekyll doesn't provide native support for generating a static website which can
-be browsed without running a web server.
-One workaround is to `wget` the website (use `make wget`).
-The truly static version will be downloaded to the .wget/ directory.
+See [DEVELOPMENT.md](DEVELOPMENT.md).
 
 License
 -------
diff --git a/_config.yml b/_config.yml
index 64e762d..c1368b2 100644
--- a/_config.yml
+++ b/_config.yml
@@ -6,6 +6,7 @@ show_drafts: true
 strict_front_matter: true
 
 exclude:
+  - DEVELOPMENT.md
   - Makefile
   - prelude.mk
   - README.md
-- 
cgit v1.2.3