barebones/README.md

46 lines
1.6 KiB
Markdown
Raw Normal View History

2012-11-14 00:42:34 +01:00
# barebones
2016-11-21 13:17:59 +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 we thought we would create our 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
2017-06-06 16:23:36 +02:00
* Scss 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-10-11 18:24:01 +02:00
* jQuery plugin agnostic
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
2017-06-06 16:23:36 +02:00
* Scss compiling and watching, css minification support
2023-08-03 13:57:13 +02:00
* Image optimisation
* Base mobile nav out of the box
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-14 13:01:51 +02:00
#### Dependencies
2014-01-30 12:32:16 +01:00
2017-06-06 16:23:36 +02:00
Install Dependencies:
```
npm install
```
```
### Using Gulp
2015-10-14 12:48:48 +02:00
2017-06-06 16:23:36 +02:00
Install Dependencies, you have haven't done yet:
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:
2023-08-03 13:57:13 +02:00
| Tasks | |
|---------------------------|--------------------------------------------------------------------|
| `npx mix watch` | *watch assets for changes* |
| `npx mix --production` | *compile for production* |