This repository has been archived on 2023-02-03. You can view files and clone it, but cannot push or open issues or pull requests.
autonomic.zone/README.md

109 lines
2.9 KiB
Markdown
Raw Normal View History

2017-09-22 09:46:39 +00:00
# How to Use
2017-09-22 09:46:39 +00:00
For those unfamiliar with how Jekyll works, check out [https://jekyllrb.com/](https://jekyllrb.com/) for all the details,
or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/),
and [creating pages](https://jekyllrb.com/docs/pages/).
2017-09-22 10:21:53 +00:00
# Quickstart
2017-09-22 09:46:39 +00:00
In order to not blow up your computer handling a system wide Ruby installation, it is
advised that you use [RVM](https://rvm.io/rvm/install). Once you've got that installed
and configured, get the latest version of Ruby with:
2017-09-22 09:46:39 +00:00
```bash
$ rvm install 2.4.2
2017-09-22 10:21:53 +00:00
```
Select that version and then create an isolated [gemset](https://rvm.io/gemsets/basics) with:
```bash
$ rvm use 2.4.2
$ rvm gemset create autonomic
2017-09-23 22:52:46 +00:00
$ rvm gemset use autonomic
2017-09-22 10:21:53 +00:00
```
Then you can get your Ruby dependencies installed with:
``` bash
$ gem install jekyll bundler
```
And serve the website locally with:
``` bash
$ jekyll serve
```
You can edit content in the `.md` files under `src` and `src/_posts`.
When you're hacking later on (or in a new shell), you'll need to run:
``` bash
$ rvm use 2.4.2
$ rvm gemset use autonomic
```
And then you'll have access to the environment.
2017-09-22 09:46:39 +00:00
# Credits
Original README from HTML5 UP:
```
2017-09-22 09:46:39 +00:00
Spectral by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
A big, modern, blocky affair with a mobile-style menu, fully responsive styling,
and an assortment of pre-styled elements. So, pretty much what you were expecting
-- except, of course, for how it's put together, specifically:
- It's built on Skel 3*, a leaner, more modular rewrite of my responsive framework.
(* = still in development as of this writing)
- It uses flexbox*, which eliminates all kinds of terrible hacks and clunky layout
stopgaps (like CSS grid systems).
(* = not supported on IE8/9, but non-flexbox fallbacks are included)
- It uses Sass* a lot more intelligently, thanks in part to several new mixins
and functions I've been working on (as well as a few by @HugoGiraudel).
2017-09-22 09:46:39 +00:00
(* = still entirely optional if you prefer vanilla CSS :)
2017-09-22 09:46:39 +00:00
- A ton of other stuff.
In short, Spectral's the culmination of several new things I'm working on/trying out,
so please, let me know what you think :)
Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
you can use for pretty much whatever.
(* = not included)
AJ
aj@lkn.io | @ajlkn
Credits:
Demo Images:
Unsplash (unsplash.com)
Icons:
Font Awesome (fortawesome.github.com/Font-Awesome)
Other:
jQuery (jquery.com)
html5shiv.js (@afarkas @jdalton @jon_neal @rem)
background-size polyfill (github.com/louisremi)
Misc. Sass functions (@HugoGiraudel)
Respond.js (j.mp/respondjs)
Skel (skel.io)
```
2017-09-22 09:46:39 +00:00
Repository [Jekyll logo](https://github.com/jekyll/brand) icon licensed under a [Creative Commons Attribution 4.0 International License](http://choosealicense.com/licenses/cc-by-4.0/).