From ea40719c4df61a95264b1c878aeadf611d5c121f Mon Sep 17 00:00:00 2001 From: James Brechtel Date: Wed, 9 Nov 2022 07:28:07 -0500 Subject: [PATCH] Adding README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b0fd37 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# My personal website + +## Building +This is a static site built with [Zola](https://www.getzola.org/). + +It uses Zola inside of docker to build and serve locally. In 'production' it's just static files served up by [Caddy](https://caddyserver.com) + +You must have [Docker](https://docker.com) installed to build the site. + +Once you clone this repo you can + +`./build` to build the static HTML. + +`./serve` to run a local webserver to serve up the content and re-build on changes. + +`./zola` will let you run zola itself for other Zola specific commands. + +## Deploying +Manual deploys can be done with `rsync` but the site should be built automatically upon a push to the `main` branch.