diff --git a/README.md b/README.md index 95e36ff..af1b41b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ -# How to Use +[![pipeline status](https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/badges/master/pipeline.svg)](https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/commits/master) -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/). +# autonomic-cooperative.gitlab.io -# Quickstart +A [Jekyll] based site for the Autonomic Cooperative. + +The template is based on the [spectral-jekyll-theme]. + +[Jekyll]: https://jekyllrb.com/ +[spectral-jekyll-theme]: https://github.com/andrewbanchich/spectral-jekyll-theme + +# Quick Start + +For those unfamiliar with how Jekyll works, check out [jekyll.rb] for all the +details, or read up on the basics of [front matter], [writing posts] and +[creating pages]. + +[jekyll.rb]: https://jekyllrb.com/ +[front matter]: https://jekyllrb.com/docs/frontmatter/ +[writing posts]: https://jekyllrb.com/docs/posts/ +[creating pages]: https://jekyllrb.com/docs/pages/ 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 @@ -44,65 +58,3 @@ $ rvm gemset use autonomic ``` And then you'll have access to the environment. - -# Credits - -Original README from HTML5 UP: - -``` -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). - - (* = still entirely optional if you prefer vanilla CSS :) - -- 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) - -``` - -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/).