barebones/README.md

78 lines
2.2 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
2015-10-14 12:10:55 +02:00
* Sass Boilerplate - semantically named files, organised by folders, 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-10-14 12:10:55 +02:00
* Laravel Elixir to define/customize and run basic Gulp tasks
2015-10-20 14:21:57 +02:00
* Basic template files
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-10-14 13:01:05 +02:00
Clone the barebones repositories into your WordPress /wp-content/themes/ directory:
2015-03-17 12:15:52 +01:00
2015-08-05 18:13:15 +02:00
git clone https://github.com/benchmarkstudios/barebones
cd barebones
2015-10-14 12:10:55 +02:00
2015-10-20 14:21:57 +02:00
To include all its optional submodules ([Simple Grid](https://github.com/benchmarkstudios/simple-grid) included):
2015-10-14 12:10:55 +02:00
2015-06-11 14:11:42 +02:00
git submodule init
git submodule update
2015-03-17 12:15:52 +01:00
2015-10-14 13:01:51 +02:00
#### Dependencies
2014-01-30 12:32:16 +01:00
2014-08-15 12:43:24 +02:00
* [Node.js](http://nodejs.org)
2015-10-14 12:44:21 +02:00
* [Gulp](http://gulpjs.com)
* [Gulp Imagemin](https://github.com/sindresorhus/gulp-imagemin)
* [Laravel Elixir](https://github.com/laravel/elixir)
2014-02-21 11:23:33 +01:00
2015-10-14 13:01:51 +02:00
### Using Gulp and Laravel Elixir
2015-10-14 12:48:48 +02:00
2015-10-14 12:51:20 +02:00
Install Gulp as a global NPM package, if you don't have it already on your machine:
2015-10-14 12:44:21 +02:00
npm install --global gulp
2015-10-14 13:01:05 +02:00
Install Laravel Elixir:
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-10-14 12:51:20 +02:00
Edit your gulpfile.js adding the required tasks (check the [Laravel Elixir](http://laravel.com/docs/master/elixir) documentation for further information).
2015-10-14 12:10:55 +02:00
2015-05-12 15:23:58 +02:00
Then run:
2015-10-14 12:31:47 +02:00
gulp
2015-10-14 12:51:20 +02:00
*to compile*
2015-10-14 12:32:25 +02:00
gulp watch
2015-10-14 12:31:47 +02:00
2015-10-14 12:51:20 +02:00
*to watch*
2015-10-14 12:32:25 +02:00
gulp --production
2015-05-12 15:23:58 +02:00
2015-10-14 12:51:20 +02:00
*to minify*
2015-10-14 12:32:25 +02:00
2015-10-14 12:10:55 +02:00
This will execute all the Gulp tasks on the gulpfile.js.
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+