From 7cf588fca0bb9fd43a96142343c611b90c78ace7 Mon Sep 17 00:00:00 2001 From: ItsDrike Date: Wed, 25 Aug 2021 09:47:29 +0200 Subject: [PATCH] Add install instructions to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17c9b21..4426163 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,12 @@ This is the source code for my personal portfolio, hosted on [my website](http://itsdrike.com) -It is built using [huge](https://gohugo.io/). + +## Building the website + +The website is built using [hugo](https://gohugo.io/), but you will also need `npm` for [Bootstrap SASS](https://getbootstrap.com/docs/5.0/customize/sass/). +The `npm` dependencies are listed in [`package.json`](./package.json) and can be installed simply by running `npm install`. + +After all NPM requirements are satisfied, to build the static webpage, run [`./scripts/build.sh`](./scripts/build.sh), which will create a `./public` directory. +This directory will contain all static files and can be used as a location for the file server. You can also use [`./scripts/server.sh`](./scripts/server.sh), which +will start the server directly with hugo. By default, this will use `http://localhost:1313`.