Adding README

This commit is contained in:
2022-11-09 07:28:07 -05:00
parent bd03c68945
commit ea40719c4d

19
README.md Normal file
View File

@@ -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.