Permalink
Browse files

Update readme.txt for wordpress.org and README.md for GitHub.

  • Loading branch information...
gonzomir committed Aug 2, 2017
1 parent e729253 commit e04aa040c43e522ff0bc653a3bd7753d5fd4a54d
Showing with 19 additions and 54 deletions.
  1. +12 −40 README.md
  2. +6 −13 readme.txt
  3. +1 −1 style.css
@@ -1,45 +1,17 @@
[![Build Status](https://travis-ci.org/Automattic/_s.svg?branch=master)](https://travis-ci.org/Automattic/_s)
Grid Magazine
=============
_s
===
Grid Magazine is a theme that uses the new Grid Layout CSS module to achieve a distinctive look for the homepage - a grid of posts with featured images, properly aligned into rows and columns.
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.
Installation
------------
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:
1. In your admin panel, go to Appearance > Themes and click the Add New button.
2. Click Upload and Choose File, then select the theme's .zip file. Click Install Now.
3. Click Activate to use your new theme right away.
* A just right amount of lean, well-commented, modern, HTML5 templates.
* A helpful 404 template.
* A custom header implementation in `inc/custom-header.php` just add the code snippet found in the comments of `inc/custom-header.php` to your `header.php` template.
* 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.
* A script at `js/navigation.js` that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. It's enqueued in `functions.php`.
* 2 sample CSS layouts in `layouts/` for a sidebar on either side of your content.
* Smartly organized starter CSS in `style.css` that will help you to quickly get your design off the ground.
* Licensed under GPLv2 or later. :) Use it to make something cool.
Credits
-------
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 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-is-awesome`), and then you'll need to do a five-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_` to capture all the function names.
3. Search for `Text Domain: _s` in style.css.
4. Search for <code>&nbsp;_s</code> (with a space before it) to capture DocBlocks.
5. Search for `_s-` to capture prefixed handles.
OR
* Search for: `'_s'` and replace with: `'megatherium-is-awesome'`
* Search for: `_s_` and replace with: `megatherium_is_awesome_`
* Search for: `Text Domain: _s` and replace with: `Text Domain: megatherium-is-awesome` in style.css.
* Search for: <code>&nbsp;_s</code> and replace with: <code>&nbsp;Megatherium_is_Awesome</code>
* Search for: `_s-` and replace with: `megatherium-is-awesome-`
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!
* Based on Underscores http://underscores.me/, (C) 2012-2016 Automattic, Inc., [GPLv2 or later](https://www.gnu.org/licenses/gpl-2.0.html)
* normalize.css http://necolas.github.io/normalize.css/, (C) 2012-2016 Nicolas Gallagher and Jonathan Neal, [MIT](http://opensource.org/licenses/MIT)
@@ -1,19 +1,17 @@
=== Grid Magazine ===
Contributors: automattic
Tags: translation-ready, custom-background, theme-options, custom-menu, post-formats, threaded-comments
Tags: grid-layout, one-column, two-columns, right-sidebar, custom-menu, featured-images, threaded-comments, translation-ready, blog, entertainment, news
Requires at least: 4.0
Tested up to: 4.7
Tested up to: 4.8
Stable tag: 1.0.0
License: GNU General Public License v2 or later
License URI: LICENSE
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A starter theme called Grid Magazine, or underscores.
A magazine / news theme that uses CSS Grid Layout on the homepage.
== Description ==
Hi. I'm a starter theme called Grid Magazine, 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.
Grid Magazine is a theme that uses the new Grid Layout CSS module to achieve a distinctive look for the homepage - a grid of posts with featured images, properly aligned into rows and columns.
== Installation ==
@@ -25,12 +23,7 @@ Hi. I'm a starter theme called Grid Magazine, or underscores, if you like. I'm a
= Does this theme support any plugins? =
Grid Magazine includes support for Infinite Scroll in Jetpack.
== Changelog ==
= 1.0 - May 12 2015 =
* Initial release
Grid Magazine includes support for Infinite Scroll in Jetpack. Contact Form 7 forms work well with the theme. If your plugin doesn't work with the theme, feel free to file an isue on [GitHub](https://github.com/gonzomir/grid-magazine/issues)
== Credits ==
@@ -11,7 +11,7 @@ Text Domain: grid-magazine
Tags: grid-layout, one-column, two-columns, right-sidebar, custom-menu, featured-images, threaded-comments, translation-ready, blog, entertainment, news
Grid Magazine is a theme that uses the new Grid Layout CSS module to achieve a distinctive
look for the homepage - a grid of posts with featured images, properly alligned into rows
look for the homepage - a grid of posts with featured images, properly aligned into rows
and columns.
This theme, like WordPress, is licensed under the GPL.

0 comments on commit e04aa04

Please sign in to comment.