From ea2707a0e0e29ce608a94d4d29ff99a18176dc42 Mon Sep 17 00:00:00 2001 From: Francesco La Camera Date: Tue, 21 Jun 2022 18:58:10 +0200 Subject: [PATCH] Add section "Building from source" to the README Add section "Building from source" to the README. This should avoid confusion/questions on how to reproduce the source files based.cooking uses (especially useful when testing/debugging on a local machine). Cheers --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index dd95bd2..527dd44 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,17 @@ they should be numbered with two digits like: `pix/chicken-parmesan-01.webp`, et Note also that images should have links beginning with a slash in this use case, i.e. `/pix/...`. +## Building from source +If you need to build this project from source, e.g. for debugging purposes, run the following: +```sh +git clone https://github.com/LukeSmithxyz/based.cooking.git +git clone https://github.com/LukeSmithxyz/lugo.git based.cooking/themes/lugo + +cd based.cooking +hugo server -D +``` +For more information on how to work with Hugo, please refer to [their official documentation](https://gohugo.io/documentation/). + ## License This website and all its content is in the public domain.