diff options
| author | Ivan Chou <me@ichou.cn> | 2017-05-31 08:58:32 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-31 08:58:32 +0300 |
| commit | ca4367cf0f8cd64a96338cdc3a6342144c853821 (patch) | |
| tree | 78d5f8910e4d2ef17d5b652869675efda51b6295 | |
| parent | 25e0221fb8983043e86f6b8c1e295ebfdad50ed7 (diff) | |
| parent | 4d6245070d02b80d66e5818f477edc5f0b6c9a0c (diff) | |
Merge pull request #9 from prashantkhurana/master
updated readme with a quick start guide
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -18,6 +18,22 @@ git clone https://github.com/IvanChou/hugo-theme-vec vec See the [official docs](http://gohugo.io/themes/installing) for more information. +## Quickstart Guide + +Make sure you have : + +1. Hugo installed +2. Test poject setup with hugo. Instructions on [hugo quickstart guide](https://gohugo.io/overview/quickstart/). +3. Cloned this repo in the themes folder. + +The [exampleSite](exampleSite) folder contains a sample site to quickly get started. + +Copy over the contents of ```config.toml``` and copy the [content](exampleSite/content) and [static](exampleSite/static) folders to your main folder. + +Build using ```hugo server --buildDrafts``` + +To create a post use ```hugo new post/post-title.md``` + ## Configuration You should config your site's `config.toml` file like: |