From 0bb0c9a5226b7877088b9d45e5e9a66991258dd1 Mon Sep 17 00:00:00 2001 From: Ben Word Date: Fri, 2 Dec 2011 14:40:35 -0700 Subject: [PATCH] better README - closes #155 --- README.md | 218 ++++++++++-------------------------------------------- 1 file changed, 40 insertions(+), 178 deletions(-) diff --git a/README.md b/README.md index 5270a6a..d2ae25e 100644 --- a/README.md +++ b/README.md @@ -1,196 +1,58 @@ -# Roots WordPress Theme [http://www.rootstheme.com/](http://www.rootstheme.com/) +# [Roots Theme](http://rootstheme.com/) -## Changelog: +Roots is a starting WordPress theme made for developers that’s based on [HTML5 Boilerplate](http://html5boilerplate.com/) and Starkers that will help you rapidly create brochure sites and blogs. -### 3.6.0: August 12th, 2011 - +Roots includes support for Blueprint CSS, 960 Grid System, 1140px Grid, Adapt.js, LESS, Foundation, and Bootstrap with the ability to set site-wide classes for the main content area and the sidebar. There's also the option to not use any CSS framework. -### 3.5.0: July 30th, 2011 - +## Quick start -### 3.2.4: May 19th, 2011 - +* 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 -### 3.2.3: May 10th, 2011 - +## Features -### 3.2.2: April 24th, 2011 - +* HTML5 Boilerplate's markup, style, and .htaccess +* Popular CSS frameworks included (with the option to use none) +* Clean URLs (no more `/wp-content/`) +* All static theme assets are rewritten to the website root (`/css/`, `/img/`, and `/js/`) +* Cleaner HTML output of navigation menus +* Root relative URLs +* Posts use the hNews microformat +* The gallery shortcode has been modified to use `
` and `
` +* `wp_head` has been cleaned up along with the output of enqueued styles and scripts +* Robots.txt optimized for SEO +* [Multilingual ready](http://www.rootstheme.com/wpml/) (English, French, Italian, Dutch, Brazilian Portuguese, Macedonian, Finnish, and Danish) -### 3.2.1: April 20th, 2011 +### Theme Options +![Theme Options](http://www.rootstheme.com/img/roots-settings.png) -
    -
  • Added support for child themes
    • -
+## Contributing -### 3.2.0: April 15th, 2011 +Anyone and everyone is welcome to contribute. There are several ways you can help out: -
    -
  • Added support for the 1140px Grid
    • -
  • Updated the conditional comment code to match latest changes to HTML5 Boilerplate
    • -
+1. Raising [issues](https://github.com/retlehs/roots/issues) on GitHub +2. Sending pull requests for bug fixes or new features and improvements +3. Making the [docs](https://github.com/retlehs/roots/wiki) better +4. Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme) -### 3.1.1: April 7th, 2011 +## Project information -
    -
  • Fixed relative path function to work correctly when WordPress is installed in a subdirectory
    • -
  • Updated jQuery to 1.5.2
    • -
  • Fixed comments to show avatars correctly
    • -
+* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots) +* Web: [http://rootstheme.com/](http://rootstheme.com/) +* 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) +* Twitter: [@retlehs](https://twitter.com/#!/retlehs) +* Contributors: [https://github.com/retlehs/roots/contributors](https://github.com/retlehs/roots/contributors) -### 3.1.0: April 1st, 2011 +## License -
    -
  • Added support for 960.gs thanks to John Liuti
    • -
  • Added more onto the .htaccess from HTML5 Boilerplate
    • -
  • Made the theme directory and name renamable
    • -
+### Major components: -### 3.0.0: March 28th, 2011 - -
    -
  • Changed name from BB to Roots
    • -
  • Updated various areas to match the latest changes to HTML5 Boilerplate
    • -
  • Changed the theme markup based on hCard/Readability Guidelines and work by Jonathan Neal
    • -
  • Theme activation now creates the navigation menus and automatically sets their locations
    • -
  • Permalink structure is now set to /%year%/%postname%/ for performance reasons
    • -
  • Uploads folder is now /assets/ and not organized by month and date
    • -
  • All static folders in /wp-content/themes/roots/ (css/, js/, img/) now rewrite to the root (/css/, /js/, /img/)
    • -
  • /wp-content/plugins/ now rewrites to /plugins/
    • -
  • More root relative URLs on WordPress functions
    • -
  • Search results (/?s=query) now rewrites to /search/query/
    • -
  • l10n.js is deregistered
    • -
  • Gallery shortcode has been changed to output <figure> and <figcaption> and now links to the file by default
    • -
  • Added more loop.php templates
    • -
  • Made the HTML editor have a monospaced font
    • -
  • Added front-page.php
    • -
  • Updated CSS for Gravity Forms 1.5
    • -
  • Added searchform.php template
    • -
- -### 2.4.0: January 25th, 2011 - -
    -
  • Added a notification when saving the theme settings
    • -
  • Added support for navigation menus
    • -
  • Created function that makes sure there is a Home page on theme activation
    • -
  • Updated various areas to match the latest changes to HTML5 Boilerplate
    • -
- -### 2.3.0: December 8th, 2010 - -
    -
  • Logo is no longer an <h1>
    • -
  • Added ARIA roles again
    • -
  • Changed ul#nav to nav#nav-main
    • -
  • Added vCard to footer
    • -
  • Made all URL's root relative
    • -
  • Added Twitter and Facebook widgets to footer
    • -
  • Added SEO optimized robots.txt from WordPress codex
    • -
- -### 2.2.0: September 20th, 2010 - -
    -
  • Added asynchronous Google Analytics
    • -
  • Updated .htaccess with latest changes from HTML5 Boilerplate
    • -
- -### 2.1.0: August 19th, 2010 - -
    -
  • Removed optimizeLegibility from headings
    • -
  • Updated jQuery to latest version
    • -
  • Implemented HTML5 Boilerplate .htaccess
    • -
- -### 2.0.1: August 2nd, 2010 - -
    -
  • Added some presentational CSS classes
    • -
  • Added footer widget
    • -
  • Added more Gravity Forms default styling
    • -
- -### 2.0.0: July 19th, 2010 - -
    -
  • Added HTML5 Boilerplate changes
    • -
  • Implemented loop.php
    • -
  • wp_head cleanup
    • -
  • Added page-subpages.php template
    • -
- -### 1.5.0: April 15th, 2010 - -
    -
  • Integrated Paul Irish's frontend-pro-template (the original HTML5 Boilerplate)
    • -
- -### 1.0.0: December 18th, 2009 - -
    -
  • Added Blueprint CSS to Starkers
    • -
- -## Contributors: - -[Scott Walkinshaw](http://www.scottwalkinshaw.com/), [Matthew Price](http://www.matthewaprice.com/), [Kyle Geminden](http://www.kylegeminden.com/), [Steve Jothen](http://twitter.com/sjothen), [John Liuti](http://twitter.com/JohnLiuti), [Jeremiah Wall](http://jeremiahwall.com/), [Jenny Jui-Shan Liang](http://jsliang.twgogo.org/), [Mason Stewart](http://masondesu.com/), [Dejan Panovski](http://webdesignplus.mk/), [Cesar Vargas](http://www.limitlis.com/), [Matthew Wrather](http://www.wrathercreative.com/), [Weslly Honorato](http://about.me/weslly) - -## License: - -Major components: - -* HTML5 Boilerplate: [The Unlicense](http://unlicense.org) +* HTML5 Boilerplate: The Unlicense * Blueprint CSS: Modified MIT License * 960 Grid System: MIT/GPL License * The 1140px Grid: CC BY-SA 3.0 Australia License -* Modernizr: MIT/BSD License -* jQuery: MIT/GPL License - -Everything else: - -* [The Unlicense](http://unlicense.org) (aka: public domain) - -## Summary: - -Roots is a starting WordPress theme made for developers that's based on HTML5 Boilerplate, Blueprint CSS/960 Grid System/1140 Grid and Starkers that will help you rapidly create brochure sites and blogs. +* jQuery: MIT/GPL license +* Modernizr: MIT/BSD license +* Respond.js: MIT/GPL license +* Normalize.css: Public Domain \ No newline at end of file