From 2412512fa92081d342b86173092b995fca80eeb1 Mon Sep 17 00:00:00 2001 From: Gerard Braad Date: Tue, 26 Nov 2024 22:45:44 +0800 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2934874..1d9e87e 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,18 @@ CRC Blog -------- -## Build -```shell +This is the source of the CRC blog. Content is written in markdown files and the output is generated using Hugo. + + +## Usage instructions +There are different ways to build the output on this repository. + +### Build using container +The simplest way to generate the output is as follows: + +```bash $ git clone https://github.com/crc-org/blog $ cd blog -$ git submodule update +$ git submodule update --init $ podman run --rm -v $PWD:/workspace ghcr.io/gbraad-redhat/hugo:0.127.0 --minify -``` \ No newline at end of file +```