Skip to content

Commit

Permalink
Added screenshot and FAQ to Readme file
Browse files Browse the repository at this point in the history
Following the sample file here: https://wordpress.org/plugins/about/readme.txt

git-svn-id: http://plugins.svn.wordpress.org/one-click-child-theme/trunk@1119234 b8457f37-d9ea-0310-8a92-e5e31aec5664
  • Loading branch information
tychay committed Mar 23, 2015
1 parent 876ec55 commit 62d1963
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 29 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# OS generated files #
######################
*/.DS_Store
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
Binary file added assets/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 56 additions & 29 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributors: tychay
Donate link: http://www.kiva.org/lender/tychay
Tags: theme, child theme, shared hosting, css, custom themeing
Requires at least: 3.0
Tested up to: 3.2.1
Tested up to: 4.1
Stable tag: trunk

Adds a Theme option to any active theme allowing you to make a child theme.
Expand All @@ -15,40 +15,76 @@ Please visit the [plugin homepage](http://terrychay.com/wordpress-plugins/one-cl
Useful for shared hosts, this allows you to easily create child themes from any
theme just by clicking.

In the current version of WordPress, you shouldn’t modify CSS of any downloaded themes
because if you update the theme, your changes will be destroyed. What you should
instead do is create a child theme and edit the CSS there, this way updates to the
parent theme will be inherited instead of destroy your changes. The problem is that
currently the only way to child theme something is edit files on the filesystem. This
is non-intuitive for shared-hosting sites with one-click WordPress installs (it
usually involves a “shell account” or learning how to use FTP).
Ever since WordPress 3.0, you shouldn’t directly modify CSS of any downloaded
themes because if you update the theme, your changes will be destroyed. Instead,
it is recommended that you create a child theme and edit the CSS there, this way
updates to the parent theme will be inherited instead of destroy your changes.
The problem is that currently the only way to child theme something is edit
files on the filesystem. This is non-intuitive for shared-hosting sites with
one-click WordPress installs (it usually involves a “shell account” or learning
how to use FTP).

This attempts to get around that issue, by adding a button to the themes page to allow
you to child theme the page. (It’s not really one-click, though.)
This attempts to get around that issue, by adding a button to the themes page to
allow you to child theme the page. (It’s not really one-click, though.)

Inspired by @janeforshort‘s and @designsimply's WordCamp SF 2011 talk on CSS theming
as requested by @sfgirl for [her blog](http://pintsizedmusings.com/).
Inspired by @janeforshort‘s and @designsimply's WordCamp SF 2011 talk on CSS
theming as requested by @sfgirl for [her blog](http://pintsizedmusings.com/).

== Installation ==

###Installing The Plugin###

Extract all files from the ZIP file, making sure to keep the file structure intact, and
then upload it to `/wp-content/plugins/`. Then just visit your admin area and activate
the plugin. That's it!
Extract all files from the ZIP file, making sure to keep the file structure
intact, and then upload it to `/wp-content/plugins/`. Then just visit your admin
area and activate the plugin. That's it!

**See Also:** ["Installing Plugins" article on the WP Codex](http://codex.wordpress.org/Managing_Plugins#Installing_Plugins)

###Using the plugin###

If you have the capability to install themes in your admin, then the themes menu will
have a new submenu called "Child Theme". Clicking on this gives you a form that will
allow you to create a child theme based on the current active theme.
If you have the capability to install themes in your admin, then the themes menu
will have a new submenu called "Child Theme". Clicking on this gives you a form
that will allow you to create a child theme based on the current active theme.

== Screenshots ==

1. To use the plugin, click one of these two palces in the Appearance section of your `wp_admin`
2. Fill out this form
3. You will see the theme will be successfully child-themed, but will track the parent theme correctly.

== Frequently Asked Questions ==

= I already modified my CSS in the existing theme? How do I use One Click Child Theme to fix this? =

You can wait for the theme to get updated and have it break it, of you can:

1. Go through the steps for installing and running the plugin above.
2. Click on the [Appearance > Editor](http://codex.wordpress.org/Appearance_Editor_SubPanel) in your admin dashboard menu (or network admin menu if multi-site).
3. Select the parent theme in the drop down on the right, click `Select` and make sure you are editing the file `style.css` (select on the right).
4. Copy the changes you made, if you managed to remember them.
5. Select the child theme you created to the drop down in the left (you should be editing `style.css`).
6. Paste your changes to the end of the file.

== Future Features ==

* Better support for grandchildren (should copy the files over)
* Add an "add file" button the the editor to allow you to edit any file.
* "add file" should be able to include() file's from the parent.
* Support for multiple theme directories
* Error support is spotty at best
* UI is ugly/terrible (no redirect)
* Use Theme_Upgrader/WP_Upgrader to figure out what files user may have trashed and ported them

== ChangeLog ==

**Version 1.3**
* Copy themes over
**Version 1.5**

* upgrade look of form to resemble most admin forms
* added Section for FAQ and Screenshots

**Version 1.4**

* Modified to account for [changed best practice from using @import to function.php](http://codex.wordpress.org/Child_Themes#How_to_Create_a_Child_Theme)

**Version 1.2**

Expand All @@ -70,12 +106,3 @@ allow you to create a child theme based on the current active theme.
* Initial release
* 456789001234567890012345678900123456789001234567890012345678900123456789001234567890

== Future Features ==

* Better support for grandchildren (should copy the files over)
* Add an "add file" button the the editor to allow you to edit any file.
* "add file" should be able to include() file's from the parent.
* Support for multiple theme directories
* Error support is spotty at best
* UI is ugly/terrible (no redirect)
* Use Theme_Upgrader/WP_Upgrader to figure out what files user may have trashed and ported them

0 comments on commit 62d1963

Please sign in to comment.