github/html5-boilerplate
1
1
Fork 0
mirror of https://github.com/h5bp/html5-boilerplate.git synced 2026-01-09 14:48:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Readme is pretty good!

Browse Source
This commit is contained in:
Rob Larsen
2020-05-26 20:34:13 -04:00
parent aaae9f9992
commit af9ef8a91d
1 changed files with 29 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -9,7 +9,7 @@
HTML5 Boilerplate is a professional front-end template for building
fast, robust, and adaptable web apps or sites.
This project is the product of years of iterative development and
This project is the product of over 10 years of iterative development and
community knowledge. It does not impose a specific development
philosophy or framework, so you're free to architect your code in the
way that you want.
@@ -23,7 +23,11 @@ way that you want.
Choose one of the following options:
* Download the latest stable release from
[html5boilerplate.com](https://html5boilerplate.com/). This zip file is a snapshot of the `dist` folder. On Windows, Mac and from the file manager on Linux unzipping this folder will output to a folder named something like `html5-boilerplate_v7.3.0`. From the command line will need to create a folder and unzip the contents into that folder.
[html5boilerplate.com](https://html5boilerplate.com/). This zip file is a
snapshot of the `dist` folder. On Windows, Mac and from the file manager on
Linux unzipping this folder will output to a folder named something like
`html5-boilerplate_v7.3.0`. From the command line will need to create a
folder and unzip the contents into that folder.
```bash
mkdir html5-boilerplate
@@ -33,11 +37,21 @@ Choose one of the following options:
* Clone the git repo — `git clone
https://github.com/h5bp/html5-boilerplate.git` - and checkout the
[tagged release](https://github.com/h5bp/html5-boilerplate/releases)
you'd like to use. The `dist` folder represents the latest version of the project for end users.
you'd like to use. The `dist` folder represents the latest version of the
project for end users.
* Install with [npm](https://www.npmjs.com/): `npm install html5-boilerplate` or [yarn](https://yarnpkg.com/): `yarn add html5-boilerplate`. The resulting `node_modules/html5-boilerplate/dist` folder represents the latest version of the project for end users. Depending on what you want to use and how you want to use it, you may have to copy and paste the contents of that folder into your project directory.
* Install with [npm](https://www.npmjs.com/): `npm install html5-boilerplate`
or [yarn](https://yarnpkg.com/): `yarn add html5-boilerplate`. The resulting
`node_modules/html5-boilerplate/dist` folder represents the latest version of
the project for end users. Depending on what you want to use and how you want
to use it, you may have to copy and paste the contents of that folder into
your project directory.
* Using our new [create-html5-boilerplate](https://github.com/h5bp/create-html5-boilerplate) project, instantly fetch the latest npm published package (or any version available on npm) with `npx`, `npm init` or `yarn create` withut having to install any dependencies. Running the following `npx` command installs the latest version into a folder called `new-site`
* Using our new [create-html5-boilerplate](https://github.com/h5bp/create-html5-boilerplate)
project, instantly fetch the latest npm published package (or any version
available on npm) with `npx`, `npm init` or `yarn create` withut having to
install any dependencies. Running the following `npx` command installs the
latest version into a folder called `new-site`
```
npx create-html5-boilerplate new-site
@@ -48,7 +62,8 @@ Choose one of the following options:
## Features
* HTML5 ready. Use the new elements with confidence.
* A finely-tuned starter template. Reap the benefits of 10 years of analysis
and experimentation by over 200 contributors.
* Designed with progressive enhancement in mind.
* Includes:
* [`Normalize.css`](https://necolas.github.com/normalize.css/)
@@ -57,7 +72,9 @@ Choose one of the following options:
detection
* [`Apache Server Configs`](https://github.com/h5bp/server-configs-apache)
that improve the web site's performance and security
* Placeholder
* Placeholder Open Graph elements and attributes.
* An example package.json file with [Parcel](https://parceljs.org/) commands
built in to jumpstart application development
* Placeholder CSS Media Queries.
* Useful CSS helper classes.
* Default print styles, performance optimized.
@@ -67,7 +84,6 @@ Choose one of the following options:
* "Delete-key friendly." Easy to strip out parts you don't need.
* Extensive documentation.
## Browser support
* Chrome *(latest 2)*
@@ -81,7 +97,8 @@ Choose one of the following options:
just that we'll ensure compatibility with the ones mentioned above.*
If you need legacy browser support you can use [HTML5 Boilerplate v6](https://github.com/h5bp/html5-boilerplate/releases/tag/6.1.0) (IE9/IE10)
or [HTML5 Boilerplate v5](https://github.com/h5bp/html5-boilerplate/releases/tag/5.3.0) (IE 8). They are no longer actively developed.
or [HTML5 Boilerplate v5](https://github.com/h5bp/html5-boilerplate/releases/tag/5.3.0)
(IE 8). They are no longer actively developed.
## Documentation
@@ -92,9 +109,9 @@ any documentation you want to write about your project.
## Contributing
Hundreds of developers have helped to make the HTML5 Boilerplate. Anyone is welcome to [contribute](.github/CONTRIBUTING.md),
however, if you decide to get involved, please take a moment to review
the [guidelines](.github/CONTRIBUTING.md):
Hundreds of developers have helped to make the HTML5 Boilerplate. Anyone is
welcome to [contribute](.github/CONTRIBUTING.md), however, if you decide to
get involved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md):
* [Bug reports](.github/CONTRIBUTING.md#bugs)
* [Feature requests](.github/CONTRIBUTING.md#features)