summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLouie S <louie@example.com>2023-12-29 14:45:35 -0500
committerLouie S <louie@example.com>2023-12-29 14:45:35 -0500
commitb1477105319de37088743c4c3ffae7c871189864 (patch)
tree2532e3283faf43f297a4764aef4d04cbdd1e179a /README
Watched through ch. 7
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 11 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..03a728c
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+Build Instructions:
+
+Simply run make in the current directory. Supported build targets include:
+
+|make all |Build HTML pages from Markdown sources (this is the default) |
+|make bdist |Build a distributable .tar.gz containing the HTML sources in dist/|
+|make sdist |Build a distributable .tar.gz containing the Markdown sources |
+|make clean |Remove HTML output |
+|make dist-clean |Remove HTML output and dist/ directory |
+
+By default, marked.js is used to compile Markdown files to HTML. To specify a different Markdown compiler, set the MARKC variable, e.g. `make MARKC=markdown`. Use at your own discretion, as results may vary, and only marked.js has been thoroughly tested to work correctly