Эх сурвалжийг харах

Merge pull request #475 from cfoellmann/master

GitHub-style Readme and Changelog files
Eddie Machado 12 жил өмнө
parent
commit
405349eed3
3 өөрчлөгдсөн 54 нэмэгдсэн , 109 устгасан
  1. 24 26
      CHANGELOG.md
  2. 0 83
      README
  3. 30 0
      README.md

+ 24 - 26
library/log.txt → CHANGELOG.md

@@ -1,4 +1,4 @@
-Bones - A Lightweight Wordpress Developer Template
+## BONES CHANGE LOG & HISTORY
 
 This theme is meant to make development easier & take
 advantage of modern web development & design techniques.
@@ -8,16 +8,14 @@ http://themble.com/bones/
 
 Author: Eddie Machado
 
-/******************************************************************
-BONES CHANGE LOG & HISTORY
-******************************************************************/
+*******************************************************************
 
-/* 1.4 update */
+**v1.4 update**
 - updated Modernizr to 2.6.2
 - merged a ton of pull requests (thanks guys and gals!)
 - added windows 8 tile support
 
-/* v1.3 update */
+**v1.3 update**
 - removed version number from scripts & styles (thanks James)
 - removed LESS (it's over Johnny, It's OVER!)
 - changed post-content to entry-content
@@ -27,7 +25,7 @@ BONES CHANGE LOG & HISTORY
 - removed unused css files (that were mistakingly compiled)
 - BORDER BOX ALL THE THINGS (http://paulirish.com/2012/box-sizing-border-box-ftw/)
 
-/* v1.25 update */
+**v1.25 update**
 - updated custom post type page for translation
 - added => to responsive jquery
 - cleaned up theme tags (which make NO sense, but are best practice, go figure)
@@ -38,7 +36,7 @@ BONES CHANGE LOG & HISTORY
 - cleaned up mixins (border radius)
 - added translations! (Chinese, Spanish)
 
-/* v1.2 HUGE update */
+**v1.2 HUGE update**
 - merge responsive version with classic
 - remove post title from read more link (it's way too long)
 - removed readme.txt (it was pointless)
@@ -74,12 +72,12 @@ BONES CHANGE LOG & HISTORY
 - rel=me can also be handled by SEO plugin or another plugin
 - removed author.php (you can use archive.php or add it yourself)
 
-/* v1.09 more updates */
+**v1.09 more updates**
 - updated admin.php to include custom widget examples, admin login styles, and admin footer
 - login.css added for custom login styles
 - custom login logo included
 
-/* v1.09 updates */
+**v1.09 updates**
 - added snippet to remove < p > from imgs (http://css-tricks.com/snippets/wordpress/remove-paragraph-tags-from-around-images/)
 - added custom admin functions file
 - updated normalize
@@ -92,7 +90,7 @@ BONES CHANGE LOG & HISTORY
 - added tag & category examples to custom post type
 
 
-/*v1.08 release (hellz yea!) */
+**v1.08 release (hellz yea!)**
 - replaced default.css with normalize.css
 - added responsive.css
 - completely revamped styles & stylesheets
@@ -132,11 +130,11 @@ BONES CHANGE LOG & HISTORY
 - removed html5 video shortcode
 
 
-/*v1.07 more changes */
+**v1.07 more changes**
 - updated selectivizr
 - compressed images
 
-/*v1.07 changes */
+**v1.07 changes**
 - added modernizr 2.0 custom build
 - added IE=edge,chrome=1 for older, shitty browsers
 - removed iphone stuff ( you can add later if you want it )
@@ -146,7 +144,7 @@ BONES CHANGE LOG & HISTORY
 - fixed errors on style.css (mostly removing example using parenthesis)
 - added jquery 1.6.1
 
-/*v1.07 w00t! */
+**v1.07 w00t!**
 - changed clear to clearfix across the board
 - added 320 & Up Boilerplate Extension by Andy Clarke
 - renamed modernizr to the current version file
@@ -154,14 +152,14 @@ BONES CHANGE LOG & HISTORY
 - updated DOMAssistant to newest version
 
 
-/*v1.06 More Updates */
+**v1.06 More Updates**
 - added theme translation to all files
 - removed categories form page meta info
 - fixed confusing copyright issues
 - removed the unneeded author / tag / ect archive title from taxonomy-custom-cat.php
 
 
-/* v1.06 Updates */
+**v1.06 Updates**
 - changed name of default stylesheet to default so it's easier to
 	debug. (having two stylesheets named style is confusing)
 - added clearing class to #inner-header and #inner-footer
@@ -178,12 +176,12 @@ BONES CHANGE LOG & HISTORY
 - adding standard categories & tags to custom post type example
 
 
-/* v1.06 */
+**v1.06**
 - added custom post type and taxonomies file
 - created custom post type template
 - added readme.txt file (really for no reason at all)
 - fixed the margin on the comments title
-- removed duplicate text-align calls in css /* Thanks Dom */
+- removed duplicate text-align calls in css **Thanks Dom**
 - added add_theme_support( 'automatic-feed-links' ) replacing
 	the deprecated automatic_feed_links();
 - added the language_attributes(); to the html tag
@@ -191,7 +189,7 @@ BONES CHANGE LOG & HISTORY
 - bloginfo('url') in header replaced with echo home_url()
 - using get_template_directory_uri() instead of bloginfo('template_directory')
 - using get_the_author_meta('display_name') instead of deprecated function
-- fixed error in bones.php for menu fallback /* thanks Mark */
+- fixed error in bones.php for menu fallback **thanks Mark**
 - creating thumbnail fallback functions
 - added header.js and moved modernizr & imgsizer in that file
 - added lazy load jquery plugin
@@ -202,7 +200,7 @@ BONES CHANGE LOG & HISTORY
 - removed the top margin of the footer menu
 
 
-/* v1.05 */
+**v1.05**
 - fixed typos in style.css file & logs
 - updated selectivizr to latest version
 - added "embed, ruby, output" to the reset stylesheet based on
@@ -212,11 +210,11 @@ BONES CHANGE LOG & HISTORY
 - added text-align styles to default stylesheet
 
 
-/* v1.04 Quick Fix */
+**v1.04 Quick Fix**
 - fixed error with script call that was deprecated.
 
 
-/* v1.04 */
+**v1.04**
 - moved the custom script call and pngfix to the footer
 	from the bones file so it's easier to see what's being
 	called.
@@ -233,24 +231,24 @@ BONES CHANGE LOG & HISTORY
 	and index pages.
 
 
-/* v1.03 */
+**v1.03**
 - public release!
 - added html5 video to plugins
 - added page navi to plugins
 - general fixes and optimization
 
 
-/* v1.02 */
+**v1.02**
 - html5 updates and semantic layout corrected
 - added search css & custom functions
 - added functionality from the html5boilerplate
 
 
-/* v1.01 */
+**v1.01**
 - added related posts functions
 - general css fixes
 
 
-/* v1.00 */
+**v1.00**
 - i thought "there must be a better way"
 - did something about it

+ 0 - 83
README

@@ -1,83 +0,0 @@
-/******************************************************************
-Bones
-A Lightweight Wordpress Development Theme
-
-_______________________________________________________________
-HEADS UP!!!
-Bones & Bones (Responsive Edition) have been merged.
-_______________________________________________________________
-
-Bones is designed to make the life of developers easier. It's built
-using HTML5 & has a strong semantic foundation. It was updated recently
-using some of the HTML5 Boilerplate's recommended markup and setup.
-It's constantly growing so be sure to check back often if you are a
-frequent user. I'm always open to contribution. :)
-
-Designed by Eddie Machado
-http://themble.com/bones
-
-License: WTFPL
-License URI: http://sam.zoy.org/wtfpl/
-Are You Serious? Yes.
-
-Special Thanks to:
-Paul Irish & the HTML5 Boilerplate
-Yoast for some WP functions & optimization ideas
-Andrew Rogers for code optimization
-David Dellanave for speed & code optimization
-and several other developers. :)
-
-Submit Bugs & or Fixes:
-https://github.com/eddiemachado/bones/issues
-
-To view Release & Update Notes, read the log.txt file inside
-the library folder.
-
-******************************************************************/
-
-/* v1.25 update */
-- updated custom post type page for translation
-- added => to responsive jquery
-- cleaned up theme tags (which make NO sense, but are best practice, go figure)
-- updated html element to match hb5
-- fixed echo problem on admin.php
-- updated normalize (LESS also had some missing styles so I added them)
-- GetComputedStyle fix for IE (for responsive js)
-- cleaned up mixins (border radius)
-- added translations! (Chinese, Spanish)
-
-/* v1.2 HUGE update */
-- merge responsive version with classic
-- remove post title from read more link (it's way too long)
-- removed readme.txt (it was pointless)
-- organized info for each file called in on the functions page
-- added custom gravatar call in comments
-- i'm leaving jQuery to a plugin (that way I'm not providing dated jQuery)
-- added translation folder
-- put everything inside stuff so it's easier to be translated
-- added an identifier in each 404 area so you know what template is showing
-- remove custom walker. I think that's better left for you guys to do
-- fixed some spelling errors
-- added some translation options in the comments file
-- added role=navigation to footer links
-- deleted image.php (who really uses that anyway)
-- added sidebar to search.php
-- added class to custom post type title
-- added link to custom meta box
-- removed selectivizr
-- updated html elements with new classes for IE
-- added new mobile meta tags
-- removed pinned site meta tag for IE9
-- merged base.css into style.css for one less call in the header
-- added styleguide page and styles (oh yea!)
-- added nav class to both menus
-- removed "Powered by Wordpress & Bones" from footer, because let's face it: we all delete this anyway.
-- added button class to submit comment button
-- removed html5 placeholder fallback (you should be using Gravity Forms)
-- added slug and rewrite to custom post type for easier urls
-- renamed the border radius mixins so they were easer to remember
-- removed duplicate box shadow mixin
-- deleted the plugins.php file
-- facebook og:meta can be better handled by a plugin (or Yoast's SEO plugin)
-- rel=me can also be handled by SEO plugin or another plugin
-- removed author.php (you can use archive.php or add it yourself)

+ 30 - 0
README.md

@@ -0,0 +1,30 @@
+# Bones
+__A Lightweight Wordpress Development Theme__
+
+Bones is designed to make the life of developers easier. It's built
+using HTML5 & has a strong semantic foundation. It was updated recently
+using some of the HTML5 Boilerplate's recommended markup and setup.
+It's constantly growing so be sure to check back often if you are a
+frequent user. I'm always open to contribution. :)
+
+Designed by **Eddie Machado**: http://themble.com/bones
+
+Special Thanks to:
+* Paul Irish & the HTML5 Boilerplate
+* Yoast for some WP functions & optimization ideas
+* Andrew Rogers for code optimization
+* David Dellanave for speed & code optimization
+* and several other developers. :)
+
+Submit Bugs & or Fixes:
+https://github.com/eddiemachado/bones/issues
+
+
+## License
+__[WTFPL](http://sam.zoy.org/wtfpl/)__
+
+	Are You Serious? Yes.
+
+
+## Meta
+* [Changelog](../../blob/master/CHANGELOG.md)