From c92963b8ac0ba2b8324b74e70d08c5b9c98b87ea Mon Sep 17 00:00:00 2001 From: Vinay Pandey Date: Wed, 22 Jun 2022 23:18:15 -0700 Subject: [PATCH] Update README.md installation section * Update the portion about initialising as Hugo module * Fix the link in `setup guide` --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbe0c9f..47c3c0c 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,25 @@ Anubis is a simple minimalist theme for [Hugo blog engine](https://gohugo.io/). You need to install an extended version of Hugo to run this theme. +### As Hugo Module (easier and recommended) + +Initiate a `hugo` module system from your project's root directory +```shell +hugo mod init github.com// +``` + +Add the following to your `config.toml` or `config.yaml` +```toml +theme = ["github.com/Mitrichius/hugo-theme-anubis"] +``` + +### As Git Submodule + Inside the folder of your Hugo site run: $ git submodule add https://github.com/mitrichius/hugo-theme-anubis.git themes/anubis -For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo. +For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo. ## Getting started After installing the theme successfully it requires a just a few more steps to get your site running.