Bones/README.md
2013-10-15 20:17:59 +01:00

83 lines
4.4 KiB
Markdown

Ribs v1.0.10
=============
> Ribs is the evolution of Skeleton, the original author seems to have disappeared and/or lost interest in the project, and my colleagues and I use this an awful lot.
## What's different here?
My fork has one significant difference over the original project, that is a full SCSS conversion to make use of more modern technologies and to expose a lot more customisation options quickly and easily.
As time goes by, and with enough interest I will gradually extend the available options and build a packaging tool that allows you to select all of your customisations in a graphical way - thinking something along the lines of jQuery themeroller, just a bit more lightweight.
### Some Key Differences
* Maintained!
* Configurable grid
* Default colours, borders, fonts, margins, padding etc are all configurable variables
* Normalized elements, rather than the old school CSS resets
* Sensible Table styles
* Taking advantage of sass, the majority of selector repetition is removed in favour of mixins that generate the selectors
* Many issues flagged by CSSLint refactored to resolve them
* The original CSS has been split out into individual files and heavily refactored to tidy it up
* Golden ratio default line heights
* A selection of useful mixins
* Push and pull column classes
* Bower installable
## Installing
Either clone this repository and drop in manually, or install from bower:
```
bower install --save ribs
```
## Build status
The project is set up to build and run csslint on Travis:
* Master: [![Build Status](https://travis-ci.org/nickpack/Ribs.png)](https://travis-ci.org/nickpack/Ribs)
* Development: [![Build Status](https://travis-ci.org/nickpack/Ribs.png?branch=develop)](https://travis-ci.org/nickpack/Ribs)
## Building
I've added grunt configuration to the repository for those of you that use it.
There are 4 main tasks added:
* default - Runs Sass to create the stylesheet from the source files, places the output in ./css then creates a minified version of the file and places it into the same directory
* test - This runs CSSLint over the output CSS file (Note that there are a few bits in the original skeleton css that I still need to fix!)
* minify - This literally just runs cssmin, useful if you've edited Ribs.css directly
* watch - This will monitor the scss directory for changes and automatically rebuild the css and minified css (Effectively the same as sass --watch but with added minification)
### To get started with the grunt tools
You need to install grunt-cli globally (`npm install -g grunt-cli`) to start with, otherwise you wont have a runner!
Then following that, from the root dir of this project, run `npm install` which will set up all of the required dependencies.
You should be good to go.
## Changelog
* Oct 15, 2013 - (v1.0.10) Resolved some issues with the grid system (Switched to margins for push/pull and removed tablet specific alpha and omega classes), Added a couple of example files.
* Oct 15, 2013 - (v1.0.9) Default flag added to variables - Thanks to Ivo Bathke (@ivoba)
* Oct 10, 2013 - (v1.0.8) Initial inline documentation, styledocco based docs generation, fixed breakpoint oversight on media queries for tablet and mobile
* Oct 10, 2013 - (v1.0.7) Documented the differences between the original skeleton project and Ribs, Updated normalize to 2.1.3
* Aug 7, 2013 - (v1.0.6) Some additional variables, grid push and pull
* Jul 17, 2013 - (v1.0.5) Some additional variables, some base table styling
* Jul 14, 2013 - (v1.0.4) Removed reset and replaced it with normalize
* May 30, 2013 - (v1.0.3) Added 1.5 * font size line heights to headings and paragraphs
* May 28, 2013 - Rename project to Ribs
* May 17, 2013 - (v1.0.2) Travis CI build configuration, and minor refactor to remove as many of the warnings from CSSLint as was feasible to do - MAY CAUSE REGRESSIONS.
* May 17, 2013 - (v1.0.1) Added grunt build tools
* Apr 23, 2013 - (v1.0.0) Skeleton SCSS v1.0 - Additional variable conversions, changes based on feedback to the original project and bower submission.
* Jan 31, 2013 - Completed SCSS conversion of Skeleton 1.2.
## Contributers
* Nick Pack
* Ivo Bathke
* Matthew Copeland
* Miles Z. Sterrett
* AtomicPages LLC
* Toby Vervaart
* Dave Gamache
## Licence
Copyright (c) 2013 Nick Pack
Based on the original skeleton project which is Copyright 2011 Dave Gamache
Licensed under the MIT license.
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/nickpack/Ribs/trend.png)](https://bitdeli.com/free "Bitdeli Badge")