modify README

main
Jerome Lachaud 10 years ago
parent a12d8b18ae
commit 7c4bf30381

@ -1,4 +1,36 @@
jeckyll.jeromelachaud.com Freelancer theme
========================= =========================
My website powered by Jeckyll and hosted on GH Jekyll theme based on [Freelancer bootstrap theme ](http://startbootstrap.com/templates/freelancer/)
## How to use
1. Place a image in `/img/portoflio/`
2. Construction a post to display your project. Use the follow as an example:
```txt
---
layout: default
modal-id: 1
date: 2014-07-18
img: cabin.png
alt: image-alt
project-date: July 2014
client: The Client
category: Web Development
description: The description of the project
---
```
4. And finally, serve Jekyll source as you would normally.
## [Demo](https://jeromelachaud.github.io/freelancer-theme)
View this jekyll theme in action [here](https://jeromelachaud.github.io/freelancer-theme)
## Screenshot
![screenshot](https://raw.githubusercontent.com/jeromelachaud/freelancer-theme/master/screenshot.png)
Localhost deployment
=========
After [downloading](https://github.com/jeromelachaud/freelancer-theme/archive/master.zip), use the normal process of serving a jekyll site. Navigate to the directory in terminal and type `jekyll build` followed by `jekyll serve`
For more details, read [documentation](http://jekyllrb.com/)

Loading…
Cancel
Save