edits
[tools.git] / README.md
Maxious 1 # [HTML5 Boilerplate](http://html5boilerplate.com)
2
3 HTML5 Boilerplate is a professional front-end template for building fast,
4 robust, and adaptable web apps or sites.
5
6 This project is the product of many years of iterative development and combined
7 community knowledge. It does not impose a specific development philosophy or
8 framework, so you're free to architect your code in the way that you want.
9
10 * Source: [https://github.com/h5bp/html5-boilerplate](https://github.com/h5bp/html5-boilerplate)
11 * Homepage: [http://html5boilerplate.com](http://html5boilerplate.com)
12 * Twitter: [@h5bp](http://twitter.com/h5bp)
13
14
15 ## Quick start
16
17 Choose one of the following options:
18
19 1. Download the latest stable release from
20 [html5boilerplate.com](http://html5boilerplate.com/) or a custom build from
21 [Initializr](http://www.initializr.com).
22 2. Clone the git repo — `git clone
23 https://github.com/h5bp/html5-boilerplate.git` - and checkout the tagged
24 release you'd like to use.
25
26
27 ## Features
28
29 * HTML5 ready. Use the new elements with confidence.
30 * Cross-browser compatible (Chrome, Opera, Safari, Firefox 3.6+, IE6+).
31 * Designed with progressive enhancement in mind.
32 * Includes [Normalize.css](http://necolas.github.com/normalize.css/) for CSS
33 normalizations and common bug fixes.
34 * The latest [jQuery](http://jquery.com/) via CDN, with a local fallback.
35 * The latest [Modernizr](http://modernizr.com/) build for feature detection.
36 * IE-specific classes for easier cross-browser control.
37 * Placeholder CSS Media Queries.
38 * Useful CSS helpers.
39 * Default print CSS, performance optimized.
40 * Protection against any stray `console.log` causing JavaScript errors in
41 IE6/7.
42 * An optimized Google Analytics snippet.
43 * Apache server caching, compression, and other configuration defaults for
44 Grade-A performance.
45 * Cross-domain Ajax and Flash.
46 * "Delete-key friendly." Easy to strip out parts you don't need.
47 * Extensive inline and accompanying documentation.
48
49
50 ## Documentation
51
52 Take a look at the [documentation table of
53 contents](/h5bp/html5-boilerplate/blob/master/doc/README.md). This
54 documentation is bundled with the project, which makes it readily available for
55 offline reading and provides a useful starting point for any documentation
56 you want to write about your project.
57
58
59 ## Contributing
60
61 Anyone and everyone is welcome to
62 [contribute](/h5bp/html5-boilerplate/blob/master/doc/contribute.md). Hundreds
63 of developers have helped make the HTML5 Boilerplate what it is today.
64