This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Michael Fields 2bfb5ef953 Merge pull request #63 from hugobaeta/readme
Include a reference to the _s generator at http://underscores.me in readme.txt. props @hugobaeta
2012-08-29 22:40:25 -07:00
inc Add todo tags to the DocBlocks of functions that contain backward compatibility with previous versions of WordPress stating when back compat should be removed. _s supports the current stable version of WordPress as well as two prior major releases. 2012-08-27 14:25:10 -07:00
js Update html5shiv.js to 3.6 stable version, props ocean90 2012-07-30 10:07:35 -07:00
layouts _s: More consistency with class names in the structural markup 2012-02-01 16:55:36 +00:00
404.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
archive.php Merge pull request #36 from kovshenin/patch-5 2012-08-27 13:06:30 -07:00
comments.php Merge pull request #25 from kwight/comments-php-comment 2012-08-06 16:14:24 -07:00
content-page.php _s: Adding starter styles along with a few markup changes to accomodate them 2012-01-13 20:10:17 +00:00
content-single.php _s: Adding starter styles along with a few markup changes to accomodate them 2012-01-13 20:10:17 +00:00
content.php Fix typo in closing comment, s/#entry-meta/.entry-meta/ 2012-07-31 08:21:53 -07:00
footer.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
functions.php s/double/single quotes in register_sidebar args array. 2012-08-27 20:20:02 +02:00
header.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
image.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
index.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
license.txt _s: initial fork of Toolbox 2012-01-07 03:25:13 +00:00
no-results.php Improve code readability in no-results.php 2012-08-14 10:30:50 +04:00
page.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
readme.txt Edited readme.txt to include a reference to the _s generator at http://underscores.me 2012-08-29 17:25:11 -07:00
rtl.css _s: initial fork of Toolbox 2012-01-07 03:25:13 +00:00
screenshot.png _s: Adding a blank screenshot 2012-02-08 20:49:01 +00:00
search.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
searchform.php Adding current search query to searchform.php 2012-08-14 10:36:37 +04:00
sidebar.php _s: This should have been an li element all along 2012-02-03 19:54:30 +00:00
single.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
style.css Update the main stylesheet to use the available classes 2012-08-25 14:06:33 -03:00

readme.txt

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

=== _s ===

Hi. I'm a starter theme called _s, or underscores, if you like. I'm a theme meant for hacking so don't use me as a Parent Theme. Instead try turning me into the next, most awesome, WordPress theme out there. That's what I'm here for.

My ultra-minimal CSS might make me look like theme tartare but that means less stuff to get in your way when you're designing your awesome theme. Here are some of the other more interesting things you'll find here ...

* A just right amount of lean, well-commented, modern, HTML5 templates.
* A helpful 404 template.
* A sample custom header implementation in inc/custom-header.php that can be activated by uncommenting one line in functions.php and adding the code snippet found the comments of inc/custom-header.php to your header.php template.
* Custom template tags in inc/template-tags that keep your templates clean and neat and prevent code duplication.
* Sample theme options in /inc/theme-options/ that can be activated by uncommenting one line in functions.php.
* Some small tweaks in /inc/tweaks.php that can improve your theming experience. They can be activated by uncommenting one line in functions.php.
* Keyboard navigation for image attachment templates. The script can be found in js/keyboard-navigation.js. Its enqueued in functions.php.
* A script at js/small-menu.js that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. Its enqueued in functions.php.
* 5 sample CSS layouts in /layouts: Two sidebars on the left, two sidebars on the right, a sidebar on either side of your content, and two-column layouts with sidebars on either side.
* Smartly organized starter CSS in style.css that will help you to quickly get your design off the ground.
* The GPL license in license.txt. :) Use it to make something cool.

=== Getting Started ===

If you want to keep it simple, head over to http://underscores.me and generate your _s based theme from there. You just input the name of the theme you want to create and click the "Generate" button and you get your ready-to-awesomize starter theme.

If you wanna do set things up manually, download _s from github. The first thing you want to do is copy the _s directory and change the name to something else. Like, say, megatherium. Then you'll need to do a three-step find and replace on the name in all the templates.

1. Search for _s inside single quotations to capture the text domain.
2. Search for _s_ for to capture all the function names
3. Search for _s with a space before it to replace all the occurrences of it in comments. (You'd replace this with the capitalized version of your theme name.)

or ...

Search for:'_s'
Replace with:'megatherium'
Search for:_s_
Replace with:megatherium_
Search for: _s
Replace with: Megatherium

Then, update the stylesheet header in style.css and the links in footer.php with your own information. Next, update or delete this readme.

Now you're ready to go! The next step is easy to say but harder to do: make an awesome WordPress theme. :)

Good luck!