From 940a33b51fe422530a2684ddcfb70e447b906f64 Mon Sep 17 00:00:00 2001 From: Noah Petherbridge Date: Tue, 3 Jul 2018 19:44:28 -0700 Subject: [PATCH] Add README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f83a32c..cfdd840 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -all: build +# noah.is -build: +* Everything in `templates/` is assumed to be a Jinja2 template. +* Everything in `static/` is assumed to be a file to be taken literally. +* Run `make build` to compile all the templates from `templates/` and copy + all of the files from `static/` into a shared public root directory called + `public/` +* Upload `public/*` to your web server. + +## Features + +* Pretty path names (`templates/about.html` -> `public/about/index.html`) + +## License + +MIT