Add extended docs to README

Additional details to clarify the esoteric parts of normalize.css.

Fix #353
This commit is contained in:
Nicolas Gallagher 2014-07-22 10:56:31 -07:00
parent 071af828a2
commit dd8d75c349

View File

@ -11,13 +11,15 @@ normalizing.
## Install ## Install
Download from the [project page](http://necolas.github.io/normalize.css/). * [npm](http://npmjs.org/): `npm install --save normalize.css`
* [Component(1)](https://github.com/component/component/): `component install necolas/normalize.css`
* [Bower](http://bower.io/): `bower install --save normalize.css`
* [Download](http://necolas.github.io/normalize.css/latest/normalize.css).
Install with [Component(1)](https://github.com/component/component/): `component install necolas/normalize.css` No other styles should come before Normalize.css.
Install with [npm](http://npmjs.org/): `npm install --save normalize.css` It is recommended that you include the `normalize.css` file as untouched
library code.
Install with [Bower](http://bower.io/): `bower install --save normalize.css`
## What does it do? ## What does it do?
@ -27,13 +29,6 @@ Install with [Bower](http://bower.io/): `bower install --save normalize.css`
* Improves usability with subtle improvements. * Improves usability with subtle improvements.
* Explains what code does using detailed comments. * Explains what code does using detailed comments.
## How to use it
No other styles should come before Normalize.css.
It is recommended that you include the `normalize.css` file as untouched
library code.
## Browser support ## Browser support
* Google Chrome (latest) * Google Chrome (latest)
@ -47,6 +42,43 @@ library code.
support](https://github.com/necolas/normalize.css/tree/v1) (IE 6+, Safari 4+), support](https://github.com/necolas/normalize.css/tree/v1) (IE 6+, Safari 4+),
but is no longer actively developed. but is no longer actively developed.
## Extended details
Additional detail and explanation of the esoteric parts of normalize.css.
#### `pre, code, kbd, samp`
The `font-family: monospace, monospace` hack fixes the inheritance and scaling
of font-size for preformated text. The duplication of `monospace` is
intentional. [Source](http://en.wikipedia.org/wiki/User:Davidgothberg/Test59).
#### `sub, sup`
Normally, using `sub` or `sup` affects the line-box height of text in all
browsers. [Source](http://gist.github.com/413930).
#### `svg:not(:root)`
Adding `overflow: hidden` fixes IE9's SVG rendering. Earlier versions of IE
don't support SVG, so we can safely use the `:not()` and `:root` selectors that
modern browsers use in the default UA stylesheets to apply this style. [SVG
Mailing List discussion](http://lists.w3.org/Archives/Public/public-svg-wg/2008JulSep/0339.html)
#### `input[type="search"]`
The search input is not fully stylable by default. In Chrome and Safari on
OSX/iOS you can't control `font`, `padding`, `border`, or `background`. In
Chrome and Safari on Windows you can't control `border` properly. It will apply
`border-width` but will only show a border color (which cannot be controlled)
for the outer 1px of that border. Applying `-webkit-appearance: textfield`
addresses these issues without removing the benefits of search inputs (e.g.
showing past searches).
#### `legend`
Adding `border: 0` corrects an IE 811 bug where `color` (yes, `color`) is not
inherited by `legend`.
## Contributing ## Contributing
Please read the CONTRIBUTING.md Please read the CONTRIBUTING.md