From 4417d54f5bf6c98b5446c333c88d36dd58bd8ce9 Mon Sep 17 00:00:00 2001 From: Hamin Mousavi Date: Sat, 15 Apr 2023 16:33:20 +0000 Subject: Updated README.md to add how to use the theme with Hugo Module imports... --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 5fc2461..ec70f96 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,29 @@ HUGO.386 is a port of the [BOOTSTRA.386](//github.com/kristopolous/BOOTSTRA.386) ![Example of Hugo blog with the theme](images/screenshot.png) ## Installation + +### As a Hugo module +Remove your previously used theme variable from your site config and remove the themes directory, or move it out of your Hugo site repo. + +In your siteconfig add the following: + +``` +[module] + [[module.imports]] + path = "gitlab.com/jmfergeau/hugo.386" + +``` + +Inside the folder of your Hugo site run: + + $ hugo mod init hugo386 + +Finally to clean up the go.mod and update/generate the go.sum file which track the module dependencies for your site, run: + + $ hugo mod tidy + +### With git submodules + Inside the folder of your Hugo site run: $ git submodule add https://gitlab.com/jmfergeau/hugo.386 themes/hugo.386 -- cgit v1.2.3