1
0
mirror of https://github.com/kremalicious/blog.git synced 2024-11-14 17:15:18 +01:00
blog/README.md

98 lines
3.4 KiB
Markdown
Raw Normal View History

2013-11-21 00:54:28 +01:00
kremalicious3
2013-11-30 17:13:19 +01:00
==================
2013-11-20 23:33:58 +01:00
> [kremalicious.com](http://kremalicious.com) based on [Jekyll](http://jekyllrb.com). Neat.
2013-12-04 23:52:22 +01:00
2014-08-10 15:30:06 +02:00
[ ![Codeship Status for kremalicious/kremalicious3](https://www.codeship.io/projects/f6973090-9f04-0131-a2b7-625e8177ce9a/status?branch=master)](https://www.codeship.io/projects/18092) [![Dependency Status](https://gemnasium.com/kremalicious/kremalicious3.svg)](https://gemnasium.com/kremalicious/kremalicious3)
2014-07-03 19:38:00 +02:00
2013-11-20 23:33:58 +01:00
Requirements
------------------
2013-12-08 15:33:16 +01:00
You need to have the following tools installed on your development machine before moving on:
- [node.js](http://nodejs.org/) & [npm](https://npmjs.org/)
2013-12-04 23:52:22 +01:00
- [Bower](http://bower.io/)
2013-12-08 15:33:16 +01:00
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/)) and [Bundler](http://bundler.io/)
2013-11-30 04:03:48 +01:00
2015-05-25 22:31:28 +02:00
Content Creation
------------------
Some handy rake tasks creating the correct front matter for each content type:
New Content | Command
----------- | -----------
Post | `rake post -- Title`
Photo | `rake photo -- Title`
Link | `rake link -- Title`
2013-11-30 17:13:19 +01:00
Get up and running
------------------
2013-11-30 04:03:48 +01:00
2013-12-08 15:33:16 +01:00
### Install dependencies
Run the following command from the repository's root folder to install all dependencies.
2014-07-03 19:38:00 +02:00
```bash
2014-08-31 18:30:30 +02:00
npm install
2013-12-04 23:52:22 +01:00
```
2013-11-30 04:03:48 +01:00
2013-12-08 15:33:16 +01:00
### Development build
2015-06-07 00:38:38 +02:00
This generates the site and assets and starts a local dev server combined with a livereloading watch task under `http://localhost:1337`.
2013-12-08 15:33:16 +01:00
2013-12-04 23:52:22 +01:00
```bash
gulp
2013-12-04 23:52:22 +01:00
```
2013-11-30 17:13:19 +01:00
2013-12-08 15:33:16 +01:00
### Production build
2015-06-07 00:38:38 +02:00
Runs almost the same tasks as `gulp server` but additionally versions all assets and optimizes all image assets.
2013-12-08 15:33:16 +01:00
2013-12-04 23:52:22 +01:00
```bash
2015-06-07 00:38:38 +02:00
gulp build
2013-12-04 23:52:22 +01:00
```
2014-08-10 14:50:44 +02:00
Licenses
------------------
### Posts
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png" /></a><br />All post content under `_src/_posts` is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
### Photos & images
All photos & image assets under `_src/_media`, `_src/assets/img`, and `assets sheet.psd` are plain ol' copyright.
Copyright (c) 20082014 Matthias Kretschmann
Don't care if you fork & play with it, but you're not allowed to publish anything from it as a whole without my written permission.
### Everything else
The MIT License (MIT)
Copyright (c) 20082014 Matthias Kretschmann
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
2015-05-25 22:31:28 +02:00
THE SOFTWARE.