commit 661243194d1e8a6d75d15d777cf4370ac1f3f01b
parent 628c104026f9c50b9272c41cf6341b36b47edac0
Author: panr <radoslaw.koziel@gmail.com>
Date: Sat, 22 Oct 2022 17:25:55 +0200
Update README
Diffstat:
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -85,7 +85,11 @@ You can download the theme manually by going to [https://github.com/panr/hugo-th
### Install theme as Hugo Module
```bash
-hugo mod init github.com/panr/hugo-theme-terminal
+# If this is the first time you're using Hugo Modules
+# in your project. You have to initiate your own module before
+# you fetch the theme module.
+#
+# hugo mod init [your website/module name]
hugo mod get github.com/panr/hugo-theme-terminal
```
@@ -99,13 +103,6 @@ and in your config file add:
path = 'github.com/panr/hugo-theme-terminal'
```
-and also remove reference to the theme (since Hugo Module don't need it):
-
-```toml
-# REMOVE OR COMMENT THIS LINE
-theme = "terminal"
-```
-
Keep in mind that the theme by default won't show up in the `themes` directory. This means that you are using the theme as it was on the repository at the moment you fetched it. Your local `go.sum` file keeps all the references. Read more about Hugo Modules in the [official documentation](https://gohugo.io/hugo-modules/).
### Install theme locally