From 4d6245070d02b80d66e5818f477edc5f0b6c9a0c Mon Sep 17 00:00:00 2001 From: Prashant Khurana Date: Sun, 28 May 2017 17:08:37 -0400 Subject: updated readme with a quick start guide --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index cb4bbd4..087f0bb 100644 --- a/README.md +++ b/README.md @@ -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: -- cgit v1.2.3