Permalink
Browse files

Added (pretty sparse) README.

  • Loading branch information...
imbrianj committed Oct 4, 2011
1 parent 43f7ba4 commit 608ec1801aa5867c0c7f3c1b4ed1c3d2d9f3b31d
Showing with 23 additions and 2 deletions.
  1. +21 −0 README.md
  2. +2 −2 debugCSS.css
View
@@ -0,0 +1,21 @@
+License
+---
+Copyrights for code authored by Yahoo! Inc. is licensed under the following terms:
+MIT License
+Copyright (c) 2011 Yahoo! Inc. All Rights Reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+What is this?
+---
+debugCSS is meant to be loaded on an existing page to highlight potentially broken, malformed or legacy (X)HTML.
+
+Not all "errors" are created equally, so they are color coded to highlight severity. Green is "probably not a big problem", yellow is "worth looking at" and red is "you really should fix this."
+
+About
+---
+Each condition is specified in three areas:
+ - Setting up the :after area for display (trying to reset common styles like colors, font sizes, etc).
+ - Specifying the color severity (green, yellow, red) and content (which is the error or warning message to be displayed).
+ - Creating the outline around the offending element according to it's color severity.
View
@@ -15,8 +15,8 @@
/*****************/
/* debugCSS is meant to be loaded on an existing page to highlight potentially
- broken, malformed or legacy code. Not all "errors" are created equally, so
- they are color coded to highlight severity. Green is "probably not a big
+ broken, malformed or legacy (X)HTML. Not all "errors" are created equally,
+ so they are color coded to highlight severity. Green is "probably not a big
problem", yellow is "worth looking at" and red is "you really should fix
this."
*/

0 comments on commit 608ec18

Please sign in to comment.