Skip to content

Commit 43e80ce

Browse files
authored
Expand README with theme installation options
Added instructions for installing the theme via manual download, cloning, and as a Git submodule.
1 parent e94ef93 commit 43e80ce

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,50 @@
33
Portfolio Web and Blog Site
44

55

6-
replicate theme
6+
Here’s a clean **README.md section** you can drop into your project:
77

8-
`git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend`
8+
---
9+
10+
## How to Start
11+
12+
You can install the theme in a few different ways depending on your workflow.
13+
14+
### Option 1: Download Manually
15+
16+
Download the theme from GitHub and place it in your project:
17+
18+
```
19+
https://github.com/rhazdon/hugo-theme-hello-friend-ng.git
20+
```
21+
22+
Then paste it into:
23+
24+
```
25+
themes/hello-friend-ng
26+
```
27+
28+
---
29+
30+
### Option 2: Clone the Repository
31+
32+
Clone the theme directly into your Hugo project:
33+
34+
```bash
35+
git clone https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng
36+
```
37+
38+
---
39+
40+
### Option 3: Use as a Git Submodule (Recommended)
41+
42+
If you want to receive updates easily without modifying the theme heavily, add it as a submodule:
43+
44+
```bash
45+
git submodule add https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng
46+
```
47+
48+
This approach allows you to keep the theme up to date with minimal effort.
49+
50+
---
51+
52+
If you want, I can expand this README with setup steps (config.toml, running Hugo, etc.).

0 commit comments

Comments
 (0)