Skip to content

Commit

Permalink
Update the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
roperzh committed Aug 9, 2014
1 parent 4ec3379 commit 08a497e
Showing 1 changed file with 80 additions and 2 deletions.
82 changes: 80 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,81 @@
# Tinyce
Tinyce
===

Tinyce is a simple [hugo](http://hugo.spf13.com) theme, aimed for personal blogs
Tinyce is a general propouse [hugo](http://hugo.spf13.com) theme.

![screenshot - 08092014 - 07 02 07 pm](https://cloud.githubusercontent.com/assets/4419992/3867787/120f0158-2011-11e4-9f50-0ccfa162cdd2.png)

You can check the live version [here](http://roperzh.github.io/tinyce-hugo-theme/).

Getting started
===

Once you have hugo up and running you must:

Create a hugo project:

```bash
$ hugo new site my-site
```

And then install tinyce:

```bash
$ cd themes
$ git clone https://github.com/roperzh/tinyce-hugo-theme
```

Now you can set tinyce as the default theme for your site adding this line
in the `config` file:

```toml
theme = "tinyce"
```

Or you can start the server with:

```bash
hugo server --theme=tinyce --buildDrafts --watch
```

Setting Variables
===

Tinyce needs a custom archetype in order to work properly, behind the covers
you will only need to define two new variables in the front matter section of
your contents.

- **color** : the color associated with the post, valid colors are: `red`,
`green`, `blue`, `yellow`, `orange` and `grey`.

- **icon** : a valid font-awesome icon name, without the `fa-` prefix, for example
instead of `fa-heart`, you only need to put `heart`. [here](http://fortawesome.github.io/Font-Awesome/cheatsheet/)
is a cheatsheet of valid icons.

***Example***

```toml
+++
Categories = ["Development", "GoLang"]
Description = "My short description"
Tags = ["Development", "golang"]
color = "green"
icon = "heart"
title = "go is cool"
date = 2014-08-09T05:04:40Z
+++

```

Contributing
===

1- Fork it

2- Create your feature branch (git checkout -b my-new-feature)

3- Commit your changes (git commit -am 'Add some feature')

4- Push to the branch (git push origin my-new-feature)

5- Create new Pull Request

0 comments on commit 08a497e

Please sign in to comment.