aboutsummaryrefslogtreecommitdiffgithub
path: root/README.md
diff options
context:
space:
mode:
authorAustin Adams <git@austinjadams.com>2017-02-28 11:57:28 -0500
committerAustin Adams <git@austinjadams.com>2017-02-28 11:59:01 -0500
commit6265923ee893e89feb3a02f0f8f7fba7e30ecffe (patch)
tree3a7dc0a0efafe1bd4a660cb6917a226d4bd487a5 /README.md
parent2af4d49255a5c842c1ced11931902848aeb5cdf1 (diff)
downloadwebzone-6265923ee893e89feb3a02f0f8f7fba7e30ecffe.tar.gz
webzone-6265923ee893e89feb3a02f0f8f7fba7e30ecffe.tar.xz
Add README with build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b7aaac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+My Hugo Website
+===============
+
+This is the statically-generated portion of my website, written using
+[Hugo][1].
+
+Getting Started
+---------------
+
+After cloning the repository and [installing hugo][2], run `hugo` to generate
+the site, and `hugo serve` to run a temporary HTTP server at
+<http://localhost:1313/>. (Pages served by the latter auto-refresh while you're
+working; it's super convenient)
+
+Tricks
+------
+
+### Atomically re-generating the site when pushing to the repo
+
+When I push to a repository on the server hosting my site, it re-generates
+automatically! I wrote [a blog post][3] with more details.
+
+### Including recent git commits
+
+The homepage includes recent commits I've made using content generated by a
+quick C program I wrote named gustave ([github][4], [cgit][5]). Using a similar
+strategy as above, whenever I push to any of my repositories, a git
+post-receive hook runs, running gustave and then hugo to re-generate the site.
+I hope to write a blog post about this soon.
+
+[1]: https://gohugo.io/
+[2]: https://github.com/spf13/hugo/releases
+[3]: https://austinjadams.com/blog/using-git-to-deploy-a-hugo-blog-atomically/
+[4]: https://github.com/ausbin/gustave/
+[5]: https://code.austinjadams.com/gustave/