forked from mirror/_s
_s: Make file paths more consistent in readme file. Props @asdfgh746.
Fixes #269.
This commit is contained in:
parent
9fc508f362
commit
1a12794a21
18
README.md
18
README.md
|
@ -7,21 +7,21 @@ My ultra-minimal CSS might make me look like theme tartare but that means less s
|
||||||
|
|
||||||
* A just right amount of lean, well-commented, modern, HTML5 templates.
|
* A just right amount of lean, well-commented, modern, HTML5 templates.
|
||||||
* A helpful 404 template.
|
* 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.
|
* 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.
|
* Custom template tags in `inc/template-tags.php` that keep your templates clean and neat and prevent code duplication.
|
||||||
* Some small tweaks in /inc/extras.php that can improve your theming experience.
|
* Some small tweaks in `inc/extras.php` that can improve your theming experience.
|
||||||
* Keyboard navigation for image attachment templates. The script can be found in js/keyboard-navigation.js. It’s enqueued in functions.php.
|
* Keyboard navigation for image attachment templates. The script can be found in `js/keyboard-navigation.js`. It's 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. It’s 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. It's 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.
|
* 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.
|
* 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.
|
* Licensed under GPLv2 or later. :) Use it to make something cool.
|
||||||
|
|
||||||
Getting Started
|
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, click the "Generate" button, and you get your ready-to-awesomize starter theme.
|
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, click the "Generate" button, and you get your ready-to-awesomize starter theme.
|
||||||
|
|
||||||
If you want to 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.
|
If you want to 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.
|
1. Search for `'_s'` (inside single quotations) to capture the text domain.
|
||||||
2. Search for `_s_` to capture all the function names.
|
2. Search for `_s_` to capture all the function names.
|
||||||
|
|
Reference in New Issue