Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/kishaningithub/hugo-shopping-product-catalogue-simple.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 10b0377..b6053b3 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,29 @@
[![Build Status](https://travis-ci.org/kishaningithub/hugo-shopping-product-catalogue-simple.svg?branch=master)](https://travis-ci.org/kishaningithub/hugo-shopping-product-catalogue-simple)
+## Installation
+
+Go to the directory where you have your Hugo site and run:
+
+```bash
+mkdir themes
+cd themes
+git clone https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple.git
+rm -rf hugo-shopping-product-catalogue-simple/.git
+```
+
+For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
+
+## Configuration
+
+After installing the Creative portfolio theme successfully, i recommend you to take a look at the [exampleSite](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/tree/master/exampleSite) directory. You will find a working Hugo site configured with the Creative portfolio theme that you can use as a starting point for your site.
+
+First, let's take a look at the [config.toml](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/tree/master/exampleSite/config.toml). It will be useful to learn how to customize your site. Feel free to play around with the settings.
+
## Contributing
-Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/issues) to let me know. Or make directly a [pull request](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/pulls). \ No newline at end of file
+Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/issues) to let me know. Or make directly a [pull request](https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple/pulls).
+
+## Thanks
+
+Thanks to [Steve Francia](https://github.com/spf13) for creating Hugo and the awesome community around the project. \ No newline at end of file