mirror of
https://github.com/pure-css/pure.git
synced 2024-11-24 10:44:21 +00:00
refactor: clean up old deploy script
This commit is contained in:
redonkulus
parent
a75cdadb3c
commit
ed00ca3a6c
@ -1,33 +1,26 @@
|
||||
How to Contribute to Pure
|
||||
=========================
|
||||
# How to Contribute to Pure
|
||||
|
||||
Feel free to [open issues][] and send pull requests on GitHub! When sending a
|
||||
pull request, please create a new topic/feature branch, and send your pull
|
||||
request from that branch. Please do *not* send pull requests from your `master`
|
||||
request from that branch. Please do _not_ send pull requests from your `master`
|
||||
branch because this tends to lead to merge conflicts.
|
||||
|
||||
In order for us to to merge your pull requests, we need you to review and sign
|
||||
our [Contributor License Agreement][]. The CLA protects you and your
|
||||
contributions along with all other developers who use Pure.
|
||||
|
||||
|
||||
[Contributor License Agreement]: #contributor-license-agreement
|
||||
[contributor license agreement]: #contributor-license-agreement
|
||||
[open issues]: https://github.com/pure-css/pure/issues
|
||||
|
||||
## Docs and Website
|
||||
|
||||
Docs and Website
|
||||
----------------
|
||||
|
||||
[Pure's website][Pure] is located in the `site` directory. Please feel free
|
||||
[Pure's website][pure] is located in the `site` directory. Please feel free
|
||||
to open issues or questions in the Issue tab.
|
||||
|
||||
|
||||
[Pure]: http://purecss.io/
|
||||
[pure]: http://purecss.io/
|
||||
[pure-site]: https://github.com/pure-css/pure/tree/master/site
|
||||
|
||||
|
||||
Building and Testing Pure
|
||||
-------------------------
|
||||
## Building and Testing Pure
|
||||
|
||||
Pure uses [Grunt][], a JavaScript task runner that runs on [Node.js][], for
|
||||
building and testing. You'll need Node.js and Grunt installed to work on Pure.
|
||||
@ -66,24 +59,21 @@ $ grunt watch
|
||||
|
||||
Pure is tested and works in:
|
||||
|
||||
* IE 8+
|
||||
* Latest Stable: Edge, Firefox, Chrome, Safari
|
||||
* iOS 6+
|
||||
* Android 4.x
|
||||
- IE 10+
|
||||
- Latest Stable: Edge, Firefox, Chrome, Safari
|
||||
- iOS 6+
|
||||
- Android 4.x
|
||||
|
||||
Before sending pull requests, please ensure that you open the test HTML files
|
||||
in these environments. If you don't have access to all these environments, list
|
||||
the ones that you have tested in on the pull request description. That way, we
|
||||
know what's missing, and can help you out.
|
||||
|
||||
[grunt]: http://gruntjs.com/
|
||||
[node.js]: http://nodejs.org/
|
||||
[csslint]: https://github.com/stubbornella/csslint
|
||||
|
||||
[Grunt]: http://gruntjs.com/
|
||||
[Node.js]: http://nodejs.org/
|
||||
[CSSLint]: https://github.com/stubbornella/csslint
|
||||
|
||||
|
||||
Coding Standards and Style Guide
|
||||
--------------------------------
|
||||
## Coding Standards and Style Guide
|
||||
|
||||
Pure has adopted the [SMACSS][] conventions for writing CSS. If you are new to
|
||||
SMACSS, you should give it a read, especially the section on [module rules][].
|
||||
@ -91,16 +81,13 @@ SMACSS, you should give it a read, especially the section on [module rules][].
|
||||
The [Extend][] section of the Pure website more info about the style guide and
|
||||
naming conventions, along with examples of how to extend the library.
|
||||
|
||||
|
||||
[SMACSS]: http://smacss.com/
|
||||
[smacss]: http://smacss.com/
|
||||
[module rules]: http://smacss.com/book/type-module
|
||||
[Extend]: http://purecss.io/extend/
|
||||
[extend]: http://purecss.io/extend/
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
Contributor License Agreement
|
||||
-----------------------------
|
||||
|
||||
Please [sign the Yahoo CLA][CLA] after sending pull requests. We can't merge
|
||||
Please [sign the Yahoo CLA][cla] after sending pull requests. We can't merge
|
||||
your pull requests unless you have a signed CLA.
|
||||
|
||||
The CLA ensures that everyone who submits a work of authorship to Pure is
|
||||
@ -122,8 +109,7 @@ making your contribution:
|
||||
**Note:** that the BSD license is very liberal; it allows for reuse and
|
||||
adaptation in commercial projects.
|
||||
|
||||
2. [Sign the Yahoo CLA][CLA] online. If you have questions about the CLA, you
|
||||
2. [Sign the Yahoo CLA][cla] online. If you have questions about the CLA, you
|
||||
can address them to opensource-cla@yahoo-inc.com.
|
||||
|
||||
|
||||
[CLA]: https://yahoocla.herokuapp.com/
|
||||
[cla]: https://yahoocla.herokuapp.com/
|
||||
|
||||
112
README.md
112
README.md
@ -1,58 +1,45 @@
|
||||
Pure
|
||||
====
|
||||
# Pure
|
||||
|
||||
[][Pure]
|
||||
[][pure]
|
||||
|
||||
A set of small, responsive CSS modules that you can use in every web project.
|
||||
[http://purecss.io/][Pure]
|
||||
[http://purecss.io/][pure]
|
||||
|
||||
|
||||
[](https://gitter.im/pure-css/pure?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
**This project is looking for maintainers to support and enhance Pure.css. If you are interested please [leave a comment](https://github.com/pure-css/pure/issues/692) in the Github issue.**
|
||||
|
||||
[Pure]: http://purecss.io/
|
||||
[Build Status]: https://travis-ci.com/pure-css/pure
|
||||
|
||||
Features
|
||||
--------
|
||||
## Features
|
||||
|
||||
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:
|
||||
|
||||
* 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][] to fix cross-browser compatibility
|
||||
- A solid base built on [Normalize.css][] to fix cross-browser compatibility
|
||||
issues.
|
||||
|
||||
* Consistently styled buttons that work with `<a>` and `<button>` elements.
|
||||
- Consistently styled buttons that work with `<a>` and `<button>` elements.
|
||||
|
||||
* Styles for vertical and horizontal menus, including support for dropdown
|
||||
- Styles for vertical and horizontal menus, including support for dropdown
|
||||
menus.
|
||||
|
||||
* Useful form alignments that look great on all screen sizes.
|
||||
- Useful form alignments that look great on all screen sizes.
|
||||
|
||||
* Various common table styles.
|
||||
- Various common table styles.
|
||||
|
||||
* An extremely minimalist look that is super-easy to customize.
|
||||
- An extremely minimalist look that is super-easy to customize.
|
||||
|
||||
* Responsive by default, with a non-responsive option.
|
||||
- Responsive by default, with a non-responsive option.
|
||||
|
||||
* Extremely small file size: **3.7KB minified + gzip**.
|
||||
- Extremely small file size: **3.7KB minified + gzip**.
|
||||
|
||||
## Get Started
|
||||
|
||||
[Normalize.css]: http://necolas.github.io/normalize.css/
|
||||
Check out the [Get Started][started] page for more information.
|
||||
|
||||
|
||||
Get Started
|
||||
-----------
|
||||
|
||||
Check out the [Get Started][Started] page for more information.
|
||||
|
||||
[Started]: https://purecss.io/start/
|
||||
|
||||
Build From Source
|
||||
-----------------
|
||||
## 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.
|
||||
@ -70,76 +57,63 @@ 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]-core.css`: The minimal set of styles, usually structural, that
|
||||
- `[module]-core.css`: The minimal set of styles, usually structural, that
|
||||
provide the base on which the rest of the module's styles build.
|
||||
|
||||
* `[module]-nr.css`: Rollup of `[module]-core.css` + `[module].css` +
|
||||
- `[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.
|
||||
|
||||
* `[module].css`: Rollup of `[module]-nr.css` + `[module]-r.css` from the
|
||||
- `[module].css`: Rollup of `[module]-nr.css` + `[module]-r.css` from the
|
||||
`build/` dir. This is the responsive version of a module.
|
||||
|
||||
* `*-min.css`: A minified file version of the files of the same name.
|
||||
- `*-min.css`: A minified file version of the files of the same name.
|
||||
|
||||
* `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.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
|
||||
- `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
|
||||
- `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
|
||||
- `pure-nr-min.css`: Minified version of `pure-nr.css` that should be used in
|
||||
production.
|
||||
|
||||
* `grids-responsive.css`: Unminified version of Pure's grid stylesheet which
|
||||
- `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
|
||||
- `grids-responsive-min.css`: Minified version of `grids-responsive.css` that
|
||||
should be used in production.
|
||||
|
||||
|
||||
[Grunt]: http://gruntjs.com/
|
||||
|
||||
|
||||
Browser Support and Testing
|
||||
---------------------------
|
||||
## Browser Support and Testing
|
||||
|
||||
Pure is tested and works in:
|
||||
|
||||
* IE 10+
|
||||
* Latest Stable: Firefox, Chrome, Safari
|
||||
* iOS 12+
|
||||
* Android 6+
|
||||
- IE 10+
|
||||
- Latest Stable: Firefox, Chrome, Safari
|
||||
- iOS 12+
|
||||
- Android 6+
|
||||
|
||||
## Docs and Website
|
||||
|
||||
Docs and Website
|
||||
----------------
|
||||
|
||||
[Pure's website][Pure] is located in the [`site`][pure-site] directory. Please feel free
|
||||
[Pure's website][pure] is located in the [`site`][pure-site] directory. Please feel free
|
||||
to open issues or questions in the Issue tab.
|
||||
|
||||
|
||||
[Pure]: http://purecss.io/
|
||||
[pure-site]: https://github.com/pure-css/pure/tree/master/site
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
## 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
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
This software is free to use under the Yahoo! Inc. BSD-3-Clause license.
|
||||
See the [LICENSE file][] for license text and copyright information.
|
||||
|
||||
|
||||
[LICENSE file]: https://github.com/pure-css/pure/blob/master/LICENSE
|
||||
[grunt]: http://gruntjs.com/
|
||||
[contributing file]: https://github.com/pure-css/pure/blob/master/CONTRIBUTING.md
|
||||
[license file]: https://github.com/pure-css/pure/blob/master/LICENSE
|
||||
[normalize.css]: http://necolas.github.io/normalize.css/
|
||||
[pure]: http://purecss.io/
|
||||
[pure-site]: https://github.com/pure-css/pure/tree/master/site
|
||||
[started]: https://purecss.io/start/
|
||||
|
||||
@ -6,7 +6,6 @@
|
||||
"url": "git://github.com/pure-css/pure.git"
|
||||
},
|
||||
"scripts": {
|
||||
"deploy": "./scripts/deploy.sh",
|
||||
"lint": "eslint . --ext .js",
|
||||
"prepare": "grunt release",
|
||||
"site:build": "npm run pretest && cd site && npm install && npm run build",
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
git config --global user.name "${GH_NAME}"
|
||||
git config --global user.email "${GH_EMAIL}"
|
||||
echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
|
||||
npm run prepare
|
||||
cp -rf ./build/ ./site/static/css/pure/
|
||||
cd site
|
||||
npm install
|
||||
GIT_USER="${GH_NAME}" npm run deploy
|
||||
Loading…
Reference in New Issue
Block a user