aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 28aeb4e..055c3a5 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
# Hugo base theme
-Hugo theme based on [gohugo](https://gohugo.io)
+Hugo theme based on the [gohugo](https://gohugo.io) website
+
+# Installation
+
+Navigate to your site folder and run the following commands :
+
+ $ mkdir themes
+ $ cd themes
+ $ git clone https://github.com/crakjie/hugo-base-theme.git
## How to use
- - Place a image in `static/img/`
+ - Place a image in `static/img/` and update `mainIcon` in config.toml
+ - You can change the header image by adding a new image in the `static/img/` folder of the theme
- Create posts to display your services. Use the follow as an example:
### post
@@ -20,8 +29,9 @@ icon = "pacman"
Hello first post
```
-### carrousel
+### carousel
+Create a carousel.md file in /content/carousel
```toml
+++