library-mirrors/pure
1
0
Fork 0
mirror of https://github.com/pure-css/pure.git synced 2024-11-07 21:34:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README formatting. Fix minor typos

Browse Source
This commit is contained in:
Tilo Mitra 2013-05-21 15:53:12 -04:00
parent 53f12841b7
commit 49f3da3b2e
1 changed files with 44 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@ -1,12 +1,13 @@
![Pure](http://f.cl.ly/items/281x142x250t0W3g1H14/pure.jpg)
Pure Pure
==== ====
![Pure](http://f.cl.ly/items/281x142x250t0W3g1H14/pure.jpg)
A set of small, responsive CSS modules that you can use in every web project. A set of small, responsive CSS modules that you can use in every web project.
Homepage: [http://www.purecss.io](http://www.purecss.io) **Homepage:** [http://purecss.io](http://purecss.io)
Get it from CDN:
**Get it from CDN:**
```html ```html
<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.0.2/pure-min.css"> <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.0.2/pure-min.css">
@ -18,22 +19,31 @@ Get it from CDN:
Pure is meant to be a starting point for every website or web app. We take care of all the CSS work that 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: every site needs, without making it look cookie-cutter:
* A responsive grid that can be customized to your needs * A responsive grid that can be customized to your needs.
* A solid base built on [normalize.css](http://necolas.github.io/normalize.css/) to fix cross-browser compatibility issues.
* Consistently styled buttons
* Styles for vertical and horizontal menus
* Useful form alignments
* Various common table styles
* An extremely minimalist look that is super-easy to customize
* Responsive by default, with a non-responsive option
* Easy one-click customization with the [Skin Builder](http://yui.github.io/skinbuilder/?mode=pure)
* Extremely small file size: ***< 5KB!***
[Check out Pure](http://www.purecss.io) * A solid base built on [normalize.css](http://necolas.github.io/normalize.css/) to fix cross-browser compatibility issues.
* Consistently styled buttons that work with `<a>` and `<button>` elements.
* 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.
* Easy one-click customization with the [Skin Builder](http://yui.github.io/skinbuilder/?mode=pure)
* Extremely small file size: *** 4.8KB minified + gzip***
[Check out Pure](http://purecss.io)
## Get Started ## Get Started
To get started using Pure, go to the [Pure CSS website](http://www.purecss.io). The website has extensive documentation and examples necessary to get you started using Pure. To get started using Pure, go to the [Pure CSS website](http://purecss.io). The website has extensive documentation and examples necessary to get you started using Pure.
You can include the Pure CSS file in your project by fetching it from Yahoo's CDN: You can include the Pure CSS file in your project by fetching it from Yahoo's CDN:
@ -46,40 +56,35 @@ You can include the Pure CSS file in your project by fetching it from Yahoo's CD
Optionally, you can build Pure from it's source on Github. To do this, you'll need to have NodeJS and npm installed. We use Grunt to build Pure. Optionally, you can build Pure from it's source on Github. To do this, you'll need to have NodeJS and npm installed. We use Grunt to build Pure.
```shell ```shell
git clone git@github.com:yui/pure.git $ git clone git@github.com:yui/pure.git
cd pure $ cd pure
npm install $ npm install
grunt $ grunt
``` ```
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 built files follow these rules: 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:
* `[module]-nr.css`: Rollup of `-core.css` + `[module].css` + `-[feature].css`. This is the non-responsive version of a module. * `build/[module]-nr.css`: Rollup of `src/[module]-core.css` + `src/[module].css` + `src/[module]-[feature].css`. This is the non-responsive version of a module.
* `[module].css`: Rollup of `-nr.css` + `-r.css`. This is the responsive version of a module.
* `*-min.css`: A minified file version of the files of the same name. * `build/[module].css`: Rollup of `build/[module]-nr.css` + `src/[module]-r.css`. This is the responsive version of a module.
* `kimono-min.css`: A rollup of all `[module].css` files. This is a responsive roll-up of everything.
* `kimono-nr-min.css`: A Rollup of all modules without @media queries. This is a non-responsive roll-up of everything. * `build/*-min.css`: A minified file version of the files of the same name.
* `build/pure-min.css`: A rollup of all `build/[module].css` files. This is a responsive roll-up of everything.
* `build/pure-nr-min.css`: A Rollup of all modules without @media queries. This is a non-responsive roll-up of everything.
### Building specific modules ### Building specific modules
You can build a specific module by passing in its name into Grunt: You can build a specific module by passing in its name into Grunt:
```shell ```shell
grunt grids $ grunt grids
``` ```
## Contributions and Code Standards ## Contributions and Code Standards
Feel free to file bugs and submit pull requests on Github! When submitting a pull request, please checkout a new branch. Don't submit pull requests from your `master` branch. To do this: Feel free to file bugs and submit pull requests on Github! When submitting a pull request, please checkout a new feature branch, and submit your pull request from it. Please do not submit pull requests from your `master` branch.
```shell
git checkout -b my-pull-request
git add .
git commit -m 'done all my commits'
git push origin my-pull-request
```
Submit a pull request from your `origin/my-pull-request` branch to `pure/master`.
### Versioning ### Versioning
@ -87,8 +92,5 @@ Pure adheres to [Semantic Versioning 2.0](http://semver.org/).
## License ## License
Copyright 2013 Yahoo! Inc. All rights reserved. Check the LICENSE.md for more information. This software is free to use under the Yahoo! Inc. BSD license.
See the [LICENSE file](https://github.com/yui/pure/blob/master/LICENSE.md) for license text and copyright information.