From ea220efc38835c335926a9b2840062d7d5f67e01 Mon Sep 17 00:00:00 2001 From: Jonathan Hodgson Date: Mon, 13 Jun 2022 11:17:12 +0100 Subject: [PATCH] Update readme --- README.md | 65 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index e271b0b..06f519f 100644 --- a/README.md +++ b/README.md @@ -4,69 +4,8 @@ This is the source code for my website: . The site is built from markdown using [pandoc](https://pandoc.org/). -## build.sh -There is a bash script, [build.sh](/jab2870/Website/src/branch/master/build.sh), that creates the necessary files in a `public_html` folder. - -This can then be hosted on any hosting service. - -The script takes the following commands: - -### Clean - -```bash -build.sh clean -``` - -This will remove the contents of the public_html folder and the tmp folder the script uses to store things like the tag list - -### Tags - -```bash -build.sh tags -``` - -This will build the taglist which is used internally and stored in the `tmp` folder as well as creating archive pages for each tag - -### Blog - -```bash -build.sh blog -``` - -This will build the blog pages for any blogs that have been modified since the last time blogs were built - -### Index - -```bash -build.sh index -``` - -This will generate the homepage. - -### Card - -```bash -build.sh card -``` - -Generates my curlable business card. - -### RSS - -```bash -build.sh rss -``` - -Generates my rss feed. - - -### All - -```bash -build.sh all -``` - -This will generate the tags, the blogs, the index, the RSS feed and the card. +To build everything, run `make all` which will build the whole site into a +/public/ folder ## Docker