mirror of
https://github.com/papercss/papercss
synced 2024-06-20 14:45:01 +02:00
Merge pull request #163 from anupamasok/master
Grammer Errors in Readme
This commit is contained in:
commit
9625bf1e5c
16
README.md
16
README.md
|
@ -42,15 +42,15 @@ There are several options available:
|
|||
|
||||
We provide compiled CSS (`paper.css`) as well as minified CSS (`paper.min.css`).
|
||||
|
||||
You can choose which components you may want to use. Only the components that get imported in `src/styles.scss` will be compiled into `dist/paper.css`.
|
||||
You can choose which components you may want to use. Only the components that get imported into `src/styles.scss` will be compiled into `dist/paper.css`.
|
||||
|
||||
You can also play with original, source files, written in SCSS, in `src/`.
|
||||
|
||||
## Documentation
|
||||
|
||||
You can view the docs at [getpapercss.com](https://www.getpapercss.com). Those are directly from the `master` branch, this means those features are stable and ready to be used in your project.
|
||||
You can view the docs at [getpapercss.com](https://www.getpapercss.com). Those are directly from the `master` branch; this means those features are stable and ready to be used in your project.
|
||||
|
||||
You can also view the develop branch at [develop.getpapercss.com](https://develop.getpapercss.com), this include new features that are coming soon in master branch. Be warned, a feature in develop can be removed without any prevention.
|
||||
You can also view the develop branch at [develop.getpapercss.com](https://develop.getpapercss.com), this includes new features that are coming soon in the master branch. Be warned, a feature in develop can be removed without any prevention.
|
||||
|
||||
## Customizing
|
||||
|
||||
|
@ -75,11 +75,11 @@ Once you are ready to contribute, here the workflow you should follow:
|
|||
- Start the local web-server: `gulp` or `npm start`
|
||||
- Write some code!
|
||||
- Check to make sure your code is following style rules with `npm run stylelint`
|
||||
- Once done commit and push your changes to your fork. The linter is also run as a precommit hook.
|
||||
- Open a pull request on the origin papercss repo. Be sure to include any pictures and/or details on what you have done, it will help reviewers **a lot**!
|
||||
- When your changes are approved, they will be merged into the `develop` branch, which will finally be merged into the `master` branch when we reach a milestone in terms of features and bug fixes. Check out [Vincent Driessen's blog post](http://nvie.com/posts/a-successful-git-branching-model/), [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html), or [#27](https://github.com/rhyneav/papercss/issues/27) for more details on how this works.
|
||||
- Once done commit and push your changes to your fork. The linter is also run as a pre-commit hook.
|
||||
- Open a pull request on the origin papercss repo. Be sure to include any pictures and/or details on what you have done; it will help reviewers **a lot**!
|
||||
- When your changes are approved, they will be merged into the `develop` branch, which will finally be merged into the `master` branch when we reach a milestone regarding features and bug fixes. Check out [Vincent Driessen's blog post](http://nvie.com/posts/a-successful-git-branching-model/), [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html), or [#27](https://github.com/rhyneav/papercss/issues/27) for more details on how this works.
|
||||
|
||||
Note: If you have a hotfix (usually typos and minor documentation tweaks), create your hotfix branch off of the master branch instead of develop: `git checkout -b hotfix-thing master`. The changes will be merged into both master and develop to keep the branches consistent.
|
||||
Note: If you have a hotfix (usually typos and minor documentation tweaks), create your hotfix branch off of the master branch instead of develop: `git checkout -b hotfix-thing master`. The changes will be merged into both the master and develop to keep the branches consistent.
|
||||
|
||||
## About
|
||||
|
||||
|
@ -87,7 +87,7 @@ PaperCSS was originally made by [@rhyneav](https://github.com/rhyneav) to be som
|
|||
|
||||
The goal of PaperCSS is to be as minimal as possible when adding classes. For example, a button should just look like a paper button. There shouldn't be a need to add a class such as `paper-button`. Because of this, adding PaperCSS to a markdown generated page should instantly paper-ize it.
|
||||
|
||||
Feel free to use it for wireframes, webapps, blogs, or whatever else you can think of!
|
||||
Feel free to use it for wireframes, web apps, blogs, or whatever else you can think of!
|
||||
|
||||
If you are new to Git or SCSS, this would be a great project to get your feet wet with. I'd be happy to help walk you through the pull request process.
|
||||
|
||||
|
|
Loading…
Reference in a new issue