barebones/README.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

2012-11-14 00:42:34 +01:00
# barebones
2014-02-06 16:16:07 +01:00
A lightweight and skeletal WordPress boilerplate theme for HTML5 and beyond. There's lots of these out there but most themes include lots of bloat and files which you might not necessarily need, so I thought I'd create my own which is great as a starting point with powerful features to encourage rapid development for most projects.
2012-11-14 00:42:34 +01:00
## Features
2012-12-20 22:33:35 +01:00
* Reset, normalisation and base font/form styles
2013-07-01 23:49:53 +02:00
* Sass powered - semantically named files all compiled into a single file
2013-08-06 10:37:22 +02:00
* Semantic use of HTML5 elements, includes Google HTML5 shiv
2012-12-20 22:24:36 +01:00
* WAI-ARIA role ready
2014-02-07 13:29:13 +01:00
* Uses [bourbon's neat](http://neat.bourbon.io) responsive grid framework
2013-11-21 10:10:59 +01:00
* Comes pre-bundled with cached CDN version of jQuery
2013-10-11 18:24:01 +02:00
* jQuery plugin agnostic
* Basic index.php Loop template
2012-12-20 22:18:50 +01:00
* Customised functions.php adding theme support for high customisation
* Minimised HTTP requests for high Web Performance
2013-10-11 18:28:37 +02:00
* Localised strings for multiple language support
2014-02-06 16:16:07 +01:00
* Gulp.js integration - automatic image optimisation, Sass compiling and watching, and css minification
2014-01-30 12:32:16 +01:00
## Installation
2014-02-03 16:36:18 +01:00
### Dependencies
2014-01-30 12:32:16 +01:00
2014-02-07 13:29:13 +01:00
* Bourbon gem
* Neat gem
2014-01-30 12:32:16 +01:00
* Node.js
2014-02-06 16:16:07 +01:00
* Gulp.js
2014-01-30 12:32:16 +01:00
2014-02-07 13:29:13 +01:00
Clone/download the barebones repositories into your WordPress /wp-content/themes/ directory, then open /barebones/ in a command line tool, such as Mac Terminal, then first install the bourbon/neat gems if you haven't already:
2014-01-30 12:32:16 +01:00
2014-02-07 13:29:13 +01:00
$ gem install bourbon
$ gem install neat
2014-02-06 16:16:07 +01:00
2014-02-07 13:29:13 +01:00
Then install bourbon/neat to the theme's css folder
$ cd css
$ bourbon install
$ neat install
and run the following to install all of this project's Gulp dependencies:
$ npm install --save-dev
Then run `gulp` to run all your Gulp tasks, which includes watching the Sass folders.
2012-12-20 22:24:36 +01:00
2012-12-20 22:33:35 +01:00
## WordPress Support
2012-12-20 22:24:36 +01:00
2013-01-01 19:43:01 +01:00
Compatible with WordPress 3.2 and above.
2012-12-20 22:24:36 +01:00
## Browser Support
2014-02-06 16:16:07 +01:00
* Internet Explorer 8.0+
2013-11-21 10:11:13 +01:00
* Firefox 3.0+
* Safari 4.0+
* Chrome 14.0+
* Opera 10.0+
2014-02-03 16:36:18 +01:00
## Roadmap
2014-02-06 16:16:07 +01:00
* ~~Phase out Internet Explorer 7 support~~
* ~~Refactor CSS using `box-sizing: border-box`~~