Skip to content

Commit

Permalink
updated readme with a quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
prashantkhurana committed May 28, 2017
1 parent 25e0221 commit 4d62450
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4d62450

Please sign in to comment.