diff --git a/README.md b/README.md index 0057774..2fd3cfc 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,60 @@ -# [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](http://twitter.github.com/bootstrap/). - -## 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 - -## 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/init.php` to setup custom navigation menus and post thumbnail sizes. - -## Documentation - -Take a look at the [documentation table of contents](doc/TOC.md). - -## Features - -* HTML5 Boilerplate’s markup and `.htaccess` -* Bootstrap from Twitter -* 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/`) -* Cleaner HTML output of navigation menus -* Cleaner output of `wp_head` and enqueued scripts/styles -* Posts use the [hNews](http://microformats.org/wiki/hnews) microformat -* [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) - -## Contributing - -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) - -## Project information - -* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots) -* Web: [http://www.rootstheme.com/](http://www.rootstheme.com/) -* Google Group: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme) -* Twitter Updates: [@retlehs](https://twitter.com/#!/retlehs) -* Contributors: [https://github.com/retlehs/roots/contributors](https://github.com/retlehs/roots/contributors) \ No newline at end of file +# [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](http://twitter.github.com/bootstrap/). + +* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots) +* Home Page: [http://www.rootstheme.com/](http://www.rootstheme.com/) +* Twitter: [@retlehs](https://twitter.com/retlehs) +* Google Group: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme) + +## 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 + +## 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/init.php` to setup custom navigation menus and post thumbnail sizes. + +## Documentation + +Take a look at the [documentation table of contents](doc/TOC.md). + +## Features + +* HTML5 Boilerplate’s markup and `.htaccess` +* Bootstrap from Twitter +* [Theme wrapper](doc/wrapper.md) +* 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/`) +* Cleaner HTML output of navigation menus +* Cleaner output of `wp_head` and enqueued scripts/styles +* 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) + +## Contributing + +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) + +## Support + +Use the [Google Group](http://groups.google.com/group/roots-theme) to ask +questions and get support.