diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2d65a1 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Source code for my website + +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. + +### All + +```bash +build.sh all +``` + +This will generate the tags, the blogs and the index + +## Docker + +To run locally, make sure docker and docker-compose are installed then run `docker-compose up`. You will be able to access the site at .