framework/bedrock
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ben Word
2012-07-15 03:30:58 -05:00
parent eae50e0a77
commit e132abf21f
1 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,38 +1,44 @@
# [Roots Theme](http://rootstheme.com/) # [Roots Theme](http://www.rootstheme.com/)
Roots is a starting WordPress theme made for developers that’s based on [HTML5 Boilerplate](http://html5boilerplate.com/) and Bootstrap from Twitter. 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/).
## Quick start ## Installation
* Clone the git repo - `git clone git://github.com/retlehs/roots.git` - or [download it](https://github.com/retlehs/roots/zipball/master) * Clone the git repo - `git clone git://github.com/retlehs/roots.git` - or [download it](https://github.com/retlehs/roots/zipball/master)
* Read [Theme Activation](https://github.com/retlehs/roots/wiki/Theme-activation) to understand everything that happens once you activate Roots * Read [Theme Activation](https://github.com/retlehs/roots/wiki/Theme-activation) to understand everything that happens once you activate Roots
## Configuration
Edit `inc/config.php` to enable support for major functionality and to define constants that are used throughout the theme.
## Features ## Features
* HTML5 Boilerplate’s markup, style, and .htaccess * HTML5 Boilerplate’s markup and `.htaccess`
* Bootstrap from Twitter * Bootstrap from Twitter
* Root relative URLs
* Clean URLs (no more `/wp-content/`) * Clean URLs (no more `/wp-content/`)
* All static theme assets are rewritten to the website root (`/css/`, `/img/`, and `/js/`) * All static theme assets are rewritten to the website root (`/css/`, `/img/`, and `/js/`)
* Cleaner HTML output of navigation menus * Cleaner HTML output of navigation menus
* Root relative URLs * Cleaner output of `wp_head` and enqueued scripts/styles
* Posts use the hNews microformat * Posts use the [hNews](http://microformats.org/wiki/hnews) microformat
* `wp_head` has been cleaned up along with the output of enqueued styles and scripts * [Multilingual ready](http://www.rootstheme.com/wpml/) (English, Spanish, French, Italian, Dutch, Brazilian Portuguese, Macedonian, Finnish, Danish, Turkish, Swedish, Bulgarian, Norwegian, Catalan, Polish, Hungarian, Russian)
* Robots.txt optimized for SEO
* [Multilingual ready](http://www.rootstheme.com/wpml/) (English, Spanish, French, Italian, Dutch, Brazilian Portuguese, Macedonian, Finnish, Danish, and Turkish)
## Contributing ## Contributing
Anyone and everyone is welcome to contribute. There are several ways you can help out: Everyone is welcome to help improve this project. There are several ways you can contribute:
1. Raising [issues](https://github.com/retlehs/roots/issues) on GitHub * Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
2. Sending pull requests for bug fixes or new features and improvements * Suggesting new features
3. Making the [docs](https://github.com/retlehs/roots/wiki) better * Writing or editing [docs](https://github.com/retlehs/roots/wiki)
4. Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme) * Writing or refactoring code
* Fixing [issues](https://github.com/retlehs/roots/issues)
* Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme)
* [Donating](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=4K7D3BCQZ4Z72&lc=US&item_name=Roots%20Theme&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)
## Project information ## Project information
* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots) * Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots)
* Web: [http://rootstheme.com/](http://rootstheme.com/) * Web: [http://www.rootstheme.com/](http://www.rootstheme.com/)
* Docs: [https://github.com/retlehs/roots/wiki](https://github.com/retlehs/roots/wiki) * Docs: [https://github.com/retlehs/roots/wiki](https://github.com/retlehs/roots/wiki)
* Mailing list: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme) * Mailing list: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme)
* Twitter: [@retlehs](https://twitter.com/#!/retlehs) * Twitter: [@retlehs](https://twitter.com/#!/retlehs)