summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNatanael Copa <ncopa@alpinelinux.org>2014-12-04 14:37:32 +0100
committerNatanael Copa <ncopa@alpinelinux.org>2014-12-04 14:57:38 +0100
commit240f35af96cbc5dfbc4e166d5f2d2df769730b19 (patch)
tree73ab2254c456aba9930f496647cc1b0ad7a0d2ca
parent4deecac0a9d1195b7d3a8c9a064aa3adb8819995 (diff)
downloadalpine-mksite-240f35af96cbc5dfbc4e166d5f2d2df769730b19.tar.bz2
alpine-mksite-240f35af96cbc5dfbc4e166d5f2d2df769730b19.tar.xz
readme: add short doc on how to build the site locally
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4c70165
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+The following dependencies are needed to build the site:
+
+ apk add make lua lua-feedparser lua-discount lua-yaml lua-lustache
+
+To build the site run:
+
+ make
+
+To set up a local web server run:
+
+ busybox httpd -p 8000 -h _out/
+
+Then point your web browser to http://loclahost:8000
+