diff options
| author | Kishan B <bkishan@thoughtworks.com> | 2018-05-12 11:11:05 +0300 |
|---|---|---|
| committer | Kishan B <bkishan@thoughtworks.com> | 2018-05-12 11:11:05 +0300 |
| commit | 17da03f9a37a39bbab170e0d791abd22536d9a40 (patch) | |
| tree | 17868764891a4392f590732fa1c445633ce9d4fc | |
| parent | 21c22f3d8b0f42dba1976d3058da30201f7f6e86 (diff) | |
Readme update
| -rw-r--r-- | .travis.yml | 4 | ||||
| -rw-r--r-- | README.md | 25 |
2 files changed, 26 insertions, 3 deletions
diff --git a/.travis.yml b/.travis.yml index c1e6298..cad6a63 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,8 +3,8 @@ sudo: false install: - mkdir tools - wget -q "https://github.com/gohugoio/hugo/releases/download/v0.40.2/hugo_0.40.2_Linux-64bit.tar.gz" -O "tools/hugo.tar.gz" - - tar -xvzf tools/hugo.tar.gz -C tools + - tar -xzf tools/hugo.tar.gz -C tools script: - git clone --depth 1 https://github.com/kishaningithub/hugo-shopping-product-catalogue-simple.git exampleSite/themes/hugo-shopping-product-catalogue-simple - - ./tools/hugo -v --source exampleSite + - ./tools/hugo -v --source exampleSite
\ No newline at end of file @@ -2,6 +2,29 @@ [](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 |