A simple web application that allows invitation based registration to a matrix instance
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

185 lines
4.9 KiB

  1. Pure
  2. ====
  3. [![Pure](https://cloud.githubusercontent.com/assets/449779/5291099/1b554cca-7b03-11e4-9157-53a12d91b34a.png)][Pure]
  4. A set of small, responsive CSS modules that you can use in every web project.
  5. [http://purecss.io/][Pure]
  6. [![Build Status](http://img.shields.io/travis/yahoo/pure.svg?style=flat)][Build Status]
  7. [![Dependency Status](https://david-dm.org/yahoo/pure/dev-status.svg)](https://david-dm.org/yahoo/pure?type=dev)
  8. [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/yahoo/pure?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  9. **Use From the CDN:**
  10. ```html
  11. <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
  12. ```
  13. Note: You can [customize which Pure modules you need][customize].
  14. **Install with Bower:**
  15. ```shell
  16. $ bower install --save pure
  17. ```
  18. **Install with NPM:**
  19. ```shell
  20. $ npm install purecss
  21. ```
  22. [Pure]: http://purecss.io/
  23. [Bower]: http://bower.io/
  24. [Build Status]: https://travis-ci.org/yahoo/pure
  25. [customize]: http://purecss.io/customize/
  26. Features
  27. --------
  28. Pure is meant to be a starting point for every website or web app. We take care
  29. of all the CSS work that every site needs, without making it look cookie-cutter:
  30. * A responsive grid that can be customized to your needs.
  31. * A solid base built on [Normalize.css][] to fix cross-browser compatibility
  32. issues.
  33. * Consistently styled buttons that work with `<a>` and `<button>` elements.
  34. * Styles for vertical and horizontal menus, including support for dropdown
  35. menus.
  36. * Useful form alignments that look great on all screen sizes.
  37. * Various common table styles.
  38. * An extremely minimalist look that is super-easy to customize.
  39. * Responsive by default, with a non-responsive option.
  40. * Extremely small file size: **4.5KB minified + gzip**.
  41. [Normalize.css]: http://necolas.github.io/normalize.css/
  42. Get Started
  43. -----------
  44. To get started using Pure, go to the [Pure CSS website][Pure]. The website has
  45. extensive documentation and examples to help you start using Pure.
  46. You can include the Pure CSS file in your project by fetching it from Yahoo's
  47. CDN:
  48. ```html
  49. <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
  50. ```
  51. You can also install Pure using [Bower][], using the following command:
  52. ```shell
  53. $ bower install --save pure
  54. ```
  55. Or you can install Pure using NPM:
  56. ```shell
  57. $ npm install purecss
  58. ```
  59. Build From Source
  60. -----------------
  61. Optionally, you can build Pure from its source on Github. To do this, you'll
  62. need to have Node.js and npm installed. We use [Grunt][] to build Pure.
  63. ```shell
  64. $ git clone git@github.com:yahoo/pure.git
  65. $ cd pure
  66. $ npm install
  67. $ grunt
  68. ```
  69. ### Build Files
  70. Now, all Pure CSS files should be built into the `pure/build/` directory. All
  71. files that are in this build directory are also available on the CDN. The naming
  72. conventions of the files in the `build/` directory follow these rules:
  73. * `[module]-core.css`: The minimal set of styles, usually structural, that
  74. provide the base on which the rest of the module's styles build.
  75. * `[module]-nr.css`: Rollup of `[module]-core.css` + `[module].css` +
  76. `[module]-[feature].css` from the `src/[module]/` dir. This is the
  77. non-responsive version of a module.
  78. * `[module].css`: Rollup of `[module]-nr.css` + `[module]-r.css` from the
  79. `build/` dir. This is the responsive version of a module.
  80. * `*-min.css`: A minified file version of the files of the same name.
  81. * `pure.css`: A rollup of all `[module].css` files in the `build/` dir. This is
  82. a responsive roll-up of everything, non-minified. Note: does not contain responsive grids with @media queries.
  83. * `pure-min.css`: Minified version of `pure.css` that should be used in
  84. production.
  85. * `pure-nr.css`: A Rollup of all modules without @media queries. This is a
  86. non-responsive roll-up of everything, non-minified.
  87. * `pure-nr-min.css`: Minified version of `pure-nr.css` that should be used in
  88. production.
  89. * `grids-responsive.css`: Unminified version of Pure's grid stylesheet which
  90. includes @media queries.
  91. * `grids-responsive-min.css`: Minified version of `grids-responsive.css` that
  92. should be used in production.
  93. [Grunt]: http://gruntjs.com/
  94. Browser Support and Testing
  95. ---------------------------
  96. Pure is tested and works in:
  97. * IE 8+
  98. * Latest Stable: Firefox, Chrome, Safari
  99. * iOS 6-8
  100. * Android 4.x
  101. Docs and Website
  102. ----------------
  103. [Pure's website][Pure] is also open source, so please open any issues or pull
  104. requests for the docs and website over at the [`pure-site`][pure-site]
  105. repository.
  106. [pure-site]: https://github.com/yahoo/pure-site
  107. Contributing
  108. ------------
  109. See the [CONTRIBUTING file][] for information on how to contribute to Pure.
  110. [CONTRIBUTING file]: https://github.com/yahoo/pure/blob/master/CONTRIBUTING.md
  111. License
  112. -------
  113. This software is free to use under the Yahoo! Inc. BSD license.
  114. See the [LICENSE file][] for license text and copyright information.
  115. [LICENSE file]: https://github.com/yahoo/pure/blob/master/LICENSE.md