barebones/README.md

55 lines
1.8 KiB
Markdown
Raw Normal View History

2012-11-14 00:42:34 +01:00
# barebones
2015-04-02 11:47:31 +02: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 we thought we would 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
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
2015-04-02 11:47:31 +02:00
* Browserify for modular JavaScript in the browser, stop those spaghetti files!
2013-10-11 18:24:01 +02:00
* 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
2015-04-02 11:47:31 +02:00
* Sass compiling and watching, css minification and live reload support
2014-01-30 12:32:16 +01:00
## Installation
2015-03-17 12:15:52 +01:00
Run the following to include barebones and all it's submodules:
2015-04-02 11:47:31 +02:00
git clone git@github.com:benchmarkstudios/barebones.git
2015-03-17 12:15:52 +01:00
2014-02-03 16:36:18 +01:00
### Dependencies
2014-01-30 12:32:16 +01:00
2014-08-15 12:43:24 +02:00
* [Node.js](http://nodejs.org)
2014-02-21 11:23:33 +01:00
#### Optional
* [LiveReload Chrome plugin](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei)
2014-01-30 12:32:16 +01:00
2014-06-20 16:59:08 +02:00
Clone/download the barebones repositories into your WordPress /wp-content/themes/ directory and run the following to install all of this project's Grunt dependencies:
2014-01-30 12:32:16 +01:00
2015-04-07 14:38:19 +02:00
npm install
2014-02-07 13:29:13 +01:00
2015-05-12 15:23:58 +02:00
Then run:
npm run watch
This will execute the default tasks: compiling sass/js and spawning the file watcher.
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
2014-02-21 11:23:33 +01:00
Compatible with WordPress 3.2 and above, but always use the latest version.
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+