summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2026-05-07 00:22:10 +0200
committerStefan Kreutz <mail@skreutz.com>2026-05-07 00:22:10 +0200
commit65fdb57da75248e3a2c3b23c177472fd7cc0ae65 (patch)
treec3bd4f49f9990d15f3dfa52bfa30d86acfb82c89 /README.md
parente27afb3235afcffad83d99aa28d74e2c88d0c652 (diff)
downloadblog-65fdb57da75248e3a2c3b23c177472fd7cc0ae65.tar.gz
Review readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index 76f7432..aea39f1 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,12 @@
# Stefan Kreutz' blog
-This is the source code of my personal website: https://www.skreutz.com/.
+This is the source code of my personal website, <https://www.skreutz.com/>.
-This project's original source code is hosted
-[here](https://git.skreutz.com/blog.git/).
+The source code is hosted on <https://git.skreutz.com/blog.git/>.
## Usage
-Build the static website generator. Note that GHC needs more than 4GB of memory
-to build Pandoc:
+Build the static website generator:
$ cabal v2-clean
$ cabal v2-update
@@ -16,6 +14,8 @@ to build Pandoc:
$ nice cabal v2-build --jobs
$ cabal v2-freeze
+**NOTE**: GHC needs more than 4GB of memory to build Pandoc.
+
Print the help text of the custom static website generator:
$ cabal v2-run exe:site -- --help
@@ -41,5 +41,4 @@ The source code is dual-licensed under [MIT](LICENSE-MIT) or [Apache License, Ve
## Credits
-Built with [Hakyll](https://jaspervdj.be/hakyll/) and
-[Pandoc](https://pandoc.org/).
+Built with [Hakyll](https://jaspervdj.be/hakyll/) and [Pandoc](https://pandoc.org/).
Generated by cgit. See skreutz.com for my tech blog and contact information.