Roots 6.5.0
This commit is contained in:
Ben Word
93
README.md
93
README.md
@@ -1,75 +1,82 @@
|
||||
# [Roots Theme](http://www.rootstheme.com/)
|
||||
# [Roots Theme](http://roots.io/)
|
||||
|
||||
Roots is a starting WordPress theme made for developers that’s based on
|
||||
[HTML5 Boilerplate](http://html5boilerplate.com/) and [Bootstrap from Twitter](http://twitter.github.com/bootstrap/).
|
||||
Roots is a WordPress starter theme based on [HTML5 Boilerplate](http://html5boilerplate.com/) & [Bootstrap](http://getbootstrap.com/) that will help you make better themes.
|
||||
|
||||
* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots)
|
||||
* Home Page: [http://www.rootstheme.com/](http://www.rootstheme.com/)
|
||||
* Source: [https://github.com/roots/roots](https://github.com/roots/roots)
|
||||
* Home Page: [http://roots.io/](http://roots.io/)
|
||||
* Twitter: [@retlehs](https://twitter.com/retlehs)
|
||||
* Newsletter: [Subscribe](http://www.rootstheme.com/subscribe/)
|
||||
* Google Group: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme)
|
||||
* Newsletter: [Subscribe](http://roots.io/subscribe/)
|
||||
* Forum: [http://discourse.roots.io/](http://discourse.roots.io/)
|
||||
|
||||
## Installation
|
||||
|
||||
* Clone the git repo - `git clone git://github.com/retlehs/roots.git` - or [download it](https://github.com/retlehs/roots/zipball/master)
|
||||
* Reference the [theme activation](doc/activation.md) documentation to understand
|
||||
everything that happens once you activate Roots
|
||||
Clone the git repo - `git clone git://github.com/roots/roots.git` - or [download it](https://github.com/roots/roots/zipball/master) and then rename the directory to the name of your theme or website. [Install Grunt](http://gruntjs.com/getting-started), and then install the dependencies for Roots contained in `package.json`:
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
If you're using Nginx you'll need to add the Roots rewrites to your server config before the PHP block (`location ~ \.php$`) to use the clean URLs feature:
|
||||
|
||||
```nginx
|
||||
location ~ ^/assets/(img|js|css)/(.*)$ {
|
||||
try_files $uri $uri/ /wp-content/themes/roots/assets/$1/$2;
|
||||
}
|
||||
location ~ ^/plugins/(.*)$ {
|
||||
try_files $uri $uri/ /wp-content/plugins/$1;
|
||||
}
|
||||
```
|
||||
|
||||
Reference the [theme activation](http://roots.io/roots-101/#theme-activation) documentation to understand everything that happens once you activate Roots.
|
||||
|
||||
## Theme Development
|
||||
|
||||
After you've installed Grunt and ran `npm install` from the theme root, use `grunt watch` to watch for updates to your LESS and JS files and Grunt will automatically re-build as you write your code.
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `lib/config.php` to enable or disable support for various theme functions
|
||||
and to define constants that are used throughout the theme.
|
||||
Edit `lib/config.php` to enable or disable support for various theme functions and to define constants that are used throughout the theme.
|
||||
|
||||
Edit `lib/init.php` to setup custom navigation menus and post thumbnail sizes.
|
||||
|
||||
## Documentation
|
||||
|
||||
Take a look at the [documentation table of contents](doc/TOC.md).
|
||||
### [Roots Docs](http://roots.io/docs/)
|
||||
|
||||
* [Roots 101](http://roots.io/roots-101/) — A guide to installing Roots, the files and theme organization
|
||||
* [Theme Wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/) — Learn all about the theme wrapper
|
||||
* [Build Script](http://roots.io/using-grunt-for-wordpress-theme-development/) — A look into the Roots build script powered by Grunt
|
||||
* [Roots Sidebar](http://roots.io/the-roots-sidebar/) — Understand how to display or hide the sidebar in Roots
|
||||
|
||||
## Features
|
||||
|
||||
* HTML5 Boilerplate’s markup
|
||||
* Bootstrap from Twitter
|
||||
* [Theme wrapper](doc/wrapper.md)
|
||||
* Organized file and template structure
|
||||
* HTML5 Boilerplate's markup along with ARIA roles and microformat
|
||||
* Bootstrap
|
||||
* [Grunt build script](http://roots.io/using-grunt-for-wordpress-theme-development/)
|
||||
* [Theme activation](http://roots.io/getting-started/#theme-activation)
|
||||
* [Theme wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/)
|
||||
* Root relative URLs
|
||||
* Clean URLs (no more `/wp-content/`)
|
||||
* All static theme assets are rewritten to the website root (`/assets/css/`,
|
||||
`/assets/img/`, and `/assets/js/`)
|
||||
* All static theme assets are rewritten to the website root (`/assets/*`)
|
||||
* Cleaner HTML output of navigation menus
|
||||
* Cleaner output of `wp_head` and enqueued scripts/styles
|
||||
* Nice search (`/search/query/`)
|
||||
* Image captions use `<figure>` and `<figcaption>`
|
||||
* Example vCard widget
|
||||
* Posts use the [hNews](http://microformats.org/wiki/hnews) microformat
|
||||
* [Multilingual ready](http://www.rootstheme.com/wpml/) (Brazilian Portuguese,
|
||||
Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian,
|
||||
Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified
|
||||
Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)
|
||||
|
||||
### Build Script
|
||||
|
||||
The [grunt branch](https://github.com/retlehs/roots/tree/grunt) contains a build
|
||||
script powered by grunt. More information can be found at [Integrating grunt.js with Roots](http://benword.com/integrating-grunt-js-with-roots/).
|
||||
|
||||
* Easily compile LESS files
|
||||
* Minification and concatenation without plugins
|
||||
* Fewer requests made to the server (one CSS file, one main JS file besides
|
||||
Modernizr and jQuery)
|
||||
* Ensures valid JavaScript
|
||||
* Others working on your project are able to use the same build script and have
|
||||
a unified development process
|
||||
* Code is optimized for production use
|
||||
* [Multilingual ready](http://roots.io/wpml/) (Brazilian Portuguese, Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian, Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)
|
||||
|
||||
## Contributing
|
||||
|
||||
Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project.
|
||||
There are several ways you can contribute:
|
||||
Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project. There are several ways you can contribute:
|
||||
|
||||
* Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
|
||||
* Suggesting new features
|
||||
* Writing or editing [docs](doc/TOC.md)
|
||||
* Writing or refactoring code
|
||||
* Fixing [issues](https://github.com/retlehs/roots/issues)
|
||||
* Replying to questions on the [Google Group](http://groups.google.com/group/roots-theme)
|
||||
* Fixing [issues](https://github.com/roots/roots/issues)
|
||||
* Replying to questions on the [forum](http://discourse.roots.io/)
|
||||
|
||||
## Support
|
||||
|
||||
Use the [Google Group](http://groups.google.com/group/roots-theme) to ask
|
||||
questions and get support.
|
||||
Use the [Roots Discourse](http://discourse.roots.io/) to ask questions and get support.
|
||||
|
||||
Reference in New Issue
Block a user