1
mirror of https://github.com/pure-css/pure synced 2024-11-30 11:29:23 +01:00
pure/README.md

186 lines
4.9 KiB
Markdown
Raw Normal View History

2013-05-16 19:01:32 +02:00
Pure
====
2013-05-20 19:23:59 +02:00
2014-12-04 00:47:36 +01:00
[![Pure](https://cloud.githubusercontent.com/assets/449779/5291099/1b554cca-7b03-11e4-9157-53a12d91b34a.png)][Pure]
2013-05-20 19:23:59 +02:00
A set of small, responsive CSS modules that you can use in every web project.
2013-05-22 14:06:01 +02:00
[http://purecss.io/][Pure]
2013-05-20 19:23:59 +02:00
[![Build Status](http://img.shields.io/travis/pure-css/pure.svg?style=flat)][Build Status]
[![Dependency Status](https://david-dm.org/pure-css/pure/dev-status.svg)](https://david-dm.org/pure-css/pure?type=dev)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pure-css/pure?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2013-05-22 14:06:01 +02:00
**Use From the CDN:**
2013-05-20 19:25:26 +02:00
```html
2017-06-05 17:00:01 +02:00
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
2013-05-20 19:25:26 +02:00
```
2013-05-20 19:23:59 +02:00
Note: You can [customize which Pure modules you need][customize].
**Install with Bower:**
```shell
$ bower install --save pure
```
**Install with NPM:**
```shell
$ npm install purecss
```
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
[Pure]: http://purecss.io/
[Bower]: http://bower.io/
[Build Status]: https://travis-ci.org/pure-css/pure
[customize]: http://purecss.io/customize/
2013-05-22 14:06:01 +02:00
Features
--------
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
Pure is meant to be a starting point for every website or web app. We take care
of all the CSS work that every site needs, without making it look cookie-cutter:
2013-05-20 19:23:59 +02:00
* A responsive grid that can be customized to your needs.
2013-05-22 14:06:01 +02:00
* A solid base built on [Normalize.css][] to fix cross-browser compatibility
issues.
* Consistently styled buttons that work with `<a>` and `<button>` elements.
2013-05-22 14:06:01 +02:00
* Styles for vertical and horizontal menus, including support for dropdown
menus.
* Useful form alignments that look great on all screen sizes.
* Various common table styles.
* An extremely minimalist look that is super-easy to customize.
* Responsive by default, with a non-responsive option.
* Extremely small file size: **4.5KB minified + gzip**.
2013-05-22 14:06:01 +02:00
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
[Normalize.css]: http://necolas.github.io/normalize.css/
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
Get Started
-----------
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
To get started using Pure, go to the [Pure CSS website][Pure]. The website has
extensive documentation and examples to help you start using Pure.
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
You can include the Pure CSS file in your project by fetching it from Yahoo's
CDN:
2013-05-20 19:23:59 +02:00
2013-05-20 19:25:26 +02:00
```html
2017-06-05 17:00:01 +02:00
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
2013-05-20 19:25:26 +02:00
```
2013-05-20 19:23:59 +02:00
You can also install Pure using [Bower][], using the following command:
2013-11-29 08:49:01 +01:00
```shell
$ bower install --save pure
```
2013-11-29 08:49:01 +01:00
Or you can install Pure using NPM:
```shell
$ npm install purecss
```
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
Build From Source
-----------------
Optionally, you can build Pure from its source on Github. To do this, you'll
need to have Node.js and npm installed. We use [Grunt][] to build Pure.
2013-05-20 19:23:59 +02:00
```shell
$ git clone git@github.com:pure-css/pure.git
$ cd pure
$ npm install
$ grunt
2013-05-20 19:23:59 +02:00
```
### Build Files
2013-05-22 14:06:01 +02:00
Now, all Pure CSS files should be built into the `pure/build/` directory. All
files that are in this build directory are also available on the CDN. The naming
conventions of the files in the `build/` directory follow these rules:
2015-06-01 09:12:07 +02:00
* `[module]-core.css`: The minimal set of styles, usually structural, that
provide the base on which the rest of the module's styles build.
2013-05-22 14:06:01 +02:00
* `[module]-nr.css`: Rollup of `[module]-core.css` + `[module].css` +
`[module]-[feature].css` from the `src/[module]/` dir. This is the
non-responsive version of a module.
2013-05-22 14:06:01 +02:00
* `[module].css`: Rollup of `[module]-nr.css` + `[module]-r.css` from the
`build/` dir. This is the responsive version of a module.
2013-05-22 14:06:01 +02:00
* `*-min.css`: A minified file version of the files of the same name.
2013-05-20 19:23:59 +02:00
* `pure.css`: A rollup of all `[module].css` files in the `build/` dir. This is
a responsive roll-up of everything, non-minified. Note: does not contain responsive grids with @media queries.
* `pure-min.css`: Minified version of `pure.css` that should be used in
production.
* `pure-nr.css`: A Rollup of all modules without @media queries. This is a
non-responsive roll-up of everything, non-minified.
* `pure-nr-min.css`: Minified version of `pure-nr.css` that should be used in
production.
2013-05-20 19:23:59 +02:00
2016-12-12 23:27:42 +01:00
* `grids-responsive.css`: Unminified version of Pure's grid stylesheet which
includes @media queries.
* `grids-responsive-min.css`: Minified version of `grids-responsive.css` that
should be used in production.
2013-05-20 19:23:59 +02:00
[Grunt]: http://gruntjs.com/
Browser Support and Testing
---------------------------
Pure is tested and works in:
2015-02-03 00:44:04 +01:00
* IE 8+
* Latest Stable: Firefox, Chrome, Safari
2015-02-04 02:38:13 +01:00
* iOS 6-8
* Android 4.x
Docs and Website
----------------
2013-05-20 19:23:59 +02:00
[Pure's website][Pure] is also open source, so please open any issues or pull
requests for the docs and website over at the [`pure-site`][pure-site]
repository.
2013-05-20 19:23:59 +02:00
2013-05-22 14:06:01 +02:00
[pure-site]: https://github.com/pure-css/pure-site
Contributing
------------
See the [CONTRIBUTING file][] for information on how to contribute to Pure.
[CONTRIBUTING file]: https://github.com/pure-css/pure/blob/master/CONTRIBUTING.md
2013-05-22 14:06:01 +02:00
License
-------
This software is free to use under the Yahoo! Inc. BSD license.
2013-05-22 14:06:01 +02:00
See the [LICENSE file][] for license text and copyright information.
[LICENSE file]: https://github.com/pure-css/pure/blob/master/LICENSE.md