Skip to content

Commit

Permalink
Started editing/updating Readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
rachelbaker committed Nov 13, 2012
1 parent 251fa8a commit ea2dd4d
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 16 deletions.
62 changes: 48 additions & 14 deletions README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,7 @@
BootstrapWP - Bootstrap Theme for WordPress BootstrapWP - Bootstrap Theme for WordPress
================= =================


![image](http://f.cl.ly/items/0o0N0e1k2X0B0l0r0n1P/BootstrapWP-Bootstrap-starter-theme.jpg) ![image](http://f.cl.ly/items/3x1o3V042y3n1X3z1t1O/BootstrapWP-v91-home.png)




Bootstrap is a responsive front-end toolkit from Twitter designed to kickstart web development, complete with core HTML, CSS, and JS for grids, type, forms, navigation, and many more components. Now you can use it with **WordPress** as a solid base to build custom themes quickly and easily. Bootstrap is a responsive front-end toolkit from Twitter designed to kickstart web development, complete with core HTML, CSS, and JS for grids, type, forms, navigation, and many more components. Now you can use it with **WordPress** as a solid base to build custom themes quickly and easily.
Expand All @@ -25,38 +25,72 @@ Download the BootstrapWP theme, and install on a WordPress local or development


This is meant to be a base theme for WordPress custom theme development. Your knowledge of WordPress theme development practices as well as understanding of HTML, CSS/LESS, jQuery and PHP are required. This is meant to be a base theme for WordPress custom theme development. Your knowledge of WordPress theme development practices as well as understanding of HTML, CSS/LESS, jQuery and PHP are required.



Getting Started
-------

1. Create a page that uses the template `Page - Home Hero`, then under `Settings->Reading` set your site to use a static front page selecting your new page.

2. Add content to the three "Home" widget areas under `Appearances->Widgets`.

3. Create a menu under `Appearances->Menus` and assign it be your site's Main Menu.

Customization Customization
------- -------


You can add your CSS **Comfortable with LESS?**
**LESS**
Check out the /assets/css/less folder where the `bootstrapwp.less` file is the master complier. The included files compile the `bootstrapwp.css` file that is located in the /assets/css folder.
**Important!** To safely retain the ability to update the less files with future versions of Bootstrap or BootstrapWP, add all custom edits/changes inside the `less/bswp-custom.less` file. **Important!** To safely retain the ability to update the less files with future versions of Bootstrap or BootstrapWP, add all custom edits/changes inside the `less/bswp-custom.less` file.




Getting Started **Not comfortable with LESS?**
-------


1. Create a page that uses the template `Hero Homepage Template`, then under `Settings->Reading` set your site to use a static front page selecting your new page. You can override the compiled bootstrapwp.css file by adding custom styles to the style.css in the theme's root directory.


2. Add content to the three "Home" widget areas under `Appearances->Widgets`.


3. Create a menu under `Appearances->Menus` and assign it be your site's Main Menu. **Prefer to create a Child Theme?**


BootstrapWP is Child Theme compatible. For more information on how to create a [Child Theme check out the WordPress Codex](http://codex.wordpress.org/Child_Themes#Directory_structure).




Bug tracker Bug tracker
----------- -----------


Please report all issues on the repo's Issue Tracker. Remember to provide as much information as possible regarding the bug/issue you are reporting so a patch can be released.

**Report theme bugs** [https://github.com/rachelbaker/bootstrapwp-Twitter-Bootstrap-for-WordPress/issues](https://github.com/rachelbaker/bootstrapwp-Twitter-Bootstrap-for-WordPress/issues) **Report theme bugs** [https://github.com/rachelbaker/bootstrapwp-Twitter-Bootstrap-for-WordPress/issues](https://github.com/rachelbaker/bootstrapwp-Twitter-Bootstrap-for-WordPress/issues)


##v.90 of BootstrapWP - Release September 9, 2012


__Release Highlights:__ ##v.91 of BootstrapWP ##

**Release Highlights:**

1. Updated to Bootstrap 2.2.1 scripts and styles
2. Fix Child Theme compatibility
3. Improved file organization with assets and template folders
4. Merged internationalization/translation contributions from [santiagogil](https://github.com/santiagogil) and [zedejose](https://github.com/zedejose)

__Assets Folder__

* Now contains the following folders: css, js, img, fonts and ico
* Removed assets/css/less/bswp-docs.less file as it is now only loaded on documentation templates.
* Updated all LESS and JS files from Bootstrap 2.2.1

__Templates-Documentation Folder__

* Holds documentation page templates and related assets
* Updated documentation templates and docs.css file from Bootstrap 2.2.1

__Templates-Pages Folder__

* Holds theme's page templates
* Changed layout on `page-home.php` to match hero template
* Removed "jumbotron" class from h1 title on `page-blog.php` template

__404.php__


1. Updated to Bootstrap 2.1 scripts and styles * Removed masthead comment to clean up template file
2. Fixed `Custom Walker Menu` PHP error
3. Fixed Automatic Thumbnail PHP errors
4. Cleaned up unnecessary theme files


__Archive.php__ __Archive.php__


Expand Down
65 changes: 63 additions & 2 deletions readme.txt
Original file line number Original file line Diff line number Diff line change
@@ -1,5 +1,66 @@
== Change Log == == Change Log ==


=.90 = 09/09/2012

__Release Highlights:__

1. Updated to Bootstrap 2.1 scripts and styles
2. Fixed `Custom Walker Menu` PHP error
3. Fixed Automatic Thumbnail PHP errors
4. Cleaned up unnecessary theme files

__Archive.php__

* Replaced conditional for `the_post_thumbnail()` with `bootstrapwp_autoset_featured_img()`.

__Author.php__

* Replaced conditional for `the_post_thumbnail()` with `bootstrapwp_autoset_featured_img()`.

__Class-bootstrapwp-walker-nav_menu.php__

* Extending Walker_Nav_Menu to modify class assigned to submenu ul element.

__Footer.php__

* Cleaned up ending div tags

__Functions.php__

* Fixed `bootstrapwp_autoset_featured_img()` function to return if there is no image set, clearing debug errors.
* Removed the post hooks for `bootstrap_autoset_featured_img()` function to clear debug errors.
* Added `bootstrapwp_post_thumbnail_check()` function to check if the post displayed in the loop has a post thumbnail already.
* Removed Custom Walker class from file and replaced with external include call for file 'includes/class-bootstrap_walker_nav_menu.php'.

__Header.php__

* Updated responsive navbar wrapping to use the button element
* Removed wp-list-pages fallback for custom menu
* Removed div elements for content-wrapper and container at end of file

__Index.php__

* Removed unnecessary double loop for page title.

__Page.php__

* Removed '<header>' element wrapping around page title.

__Page-blog.php__

* Replaced conditional for `the_post_thumbnail()` with `bootstrapwp_autoset_featured_img()`.

__Docs Folder__

* Removed entire 'docs' folder to clean up theme files.

__IMG Folder__

* Removed sub-folder 'example-sites' to clean up theme files.
* Removed sub-folder 'examples' to clean up theme files.
* Updated with new images and icons from Bootstrap 2.1


= .87 = 06/04/2012 = .87 = 06/04/2012


**Release Highlights:** **Release Highlights:**
Expand All @@ -18,7 +79,7 @@ __Functions.php__


__Style.css__ __Style.css__


* Removed content because it this file is not loaded via `bootstrapwp_css_loader()` * Removed content because it this file is not loaded via `bootstrapwp_css_loader()`
* Added note to add custom updates to the less/bswp-custom.less file to safely retain the ability to update the less files with future versions of Bootstrap or BootstrapWP * Added note to add custom updates to the less/bswp-custom.less file to safely retain the ability to update the less files with future versions of Bootstrap or BootstrapWP
* Bumped version to .87 * Bumped version to .87


Expand Down Expand Up @@ -59,7 +120,7 @@ __LESS Folder__


__IMG Folder__ __IMG Folder__


* Updated glyph icons with new set included in Bootstrap 2.04 * Updated glyph icons with new set included in Bootstrap 2.04






Expand Down

0 comments on commit ea2dd4d

Please sign in to comment.