Commit 059dbcd3 authored by Capi Etheriel's avatar Capi Etheriel

[blog] add readme

parent e59cedaf
# hikari
# Barraponto Blog
Hikari is an open-source [Jekyll](http://jekyllrb.com) theme perfect for dev-savvy bloggers who wants to get started with Jekyll in a very minimal way.
Hosted at https://barraponto.blog.br
Deployed on Gitlab Pages using Jekyll.
- SCSS!
- Responsive
- Lightweight (no JS library has been abused here)
## How to write
![preview](https://dl.dropboxusercontent.com/u/7539881/Hikari/hikari-screenshot.png)
```
bundle exec draft "name of new draft"
bundle exec publish path/to/draft
```
![preview](https://dl.dropboxusercontent.com/u/7539881/Hikari/hikari-screenshot-2.png)
## How to install
![preview](https://dl.dropboxusercontent.com/u/7539881/Hikari/hikari-screenshot-3.png)
```
gem install bundler
bundle install
```
[View demo](http://m3xm.github.io/hikari-for-Jekyll)
## How to update
```
bundle update github-pages
```
### How to install
## How to deploy
1. Clone this repo
2. Customize \_config.yml and replace all dummy posts by yours
3. Change your profile picture in `~/assets/img/avatar.jpg`
3. Publish (I recommend [GitHub Pages](https://help.github.com/articles/using-jekyll-with-pages), it's free)
### Development
- `master` for development and pull requests.
- `gh-pages` for the demo page; don't bother.
#### Running locally
1. Clone this repo
2. Install required dependencies with [Bundler](http://bundler.io/)
bundle install
3. Run the site with Jekyll
bundle exec jekyll serve --watch
4. Visit the site at [http://localhost:4000](http://localhost:4000)
### Author
**Mathieu Mayer-Mazzoli**
- <http://m3xm.github.io>
- <http://twitter.com/mx3m>
- <http://www.dribbble.com/m3xm>
### Main Contributors
**Ross Allen**
- <https://github.com/ssorallen>
**Julien Rousseau**
- <https://github.com/evarouss>
### License
The MIT License (MIT)
Copyright (c) 2015 Mathieu Mayer-Mazzoli
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
git push gitlab master
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment