thanthos/Font-Awesome-Pro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Syncing & Updating README (#1016)

Browse Source 
syncing README with Font-Awesome repo.
This commit is contained in:
Brian Talbot
2018-02-07 11:04:33 -05:00
committed by GitHub
parent f9caec3cf6
commit faac9475f2
7 changed files with 210 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@@ -24,32 +24,46 @@ Learn how to [get started](https://fontawesome.com/get-started) with Font Awesom
Login to your https://fontawesome.com account to download the latest version of Font Awesome Pro.
## Project Progress
Keep track of our progress through this project's [change log](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CHANGELOG.md). Want to keep up with what's planned for Font Awesome Pro? Check out [our milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open).
## Change log
## How We'll Work
We'll keep track of each release in the [CHANGELOG.md](./CHANGELOG.md)
### Icon Design Workflow
Looking for older versions of Font Awesome? Check the [releases](https://github.com/FortAwesome/Font-Awesome-Pro/releases)
We'll be releasing design concepts for icons as we make progress. Please check the project's [milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open) for icon design status. Icons will be organized in the following ways:
## Code of conduct
* Icons will be kept within the [`icons`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory in the repo.
* Font Awesome Free icons will be organized in the [`icons/free`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory
* Font Awesome Pro icons will be organized in the [`icons/pro`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons/free) directory
* Icon category packs will be contained within the `_categories` folder of `free`/`pro` directories.
* Each icon will have a production-ready version (`[icon-name].svg`) created for each of its styles and states.
* We may eventually add preview boards of different icon groups (styles, categories, etc.) for easier browsing/consistency reviews.
* We may share more work in progress files for specific icons as part of pull requests.
We'll use the following tools to design and produce icons:
* Adobe Illustrator
* Inkscribe
* SVGO for optimization
We will behave ourselves if you behave yourselves. For more details see our
[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
## Contributing
Contributions, in code and constructive feedback, are very welcome. Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CONTRIBUTING.md).
Included are directions for opening issues, coding standards, and community expectations.
Please read through our [contributing guidelines](./CONTRIBUTING.md). Included
are directions for opening issues.
## Versioning
Font Awesome Pro will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
with the following format:
`<major>.<minor>.<patch>`
For more information on SemVer, please visit http://semver.org.
**The major version "5" is part of an umbrella release. It includes many different types of files and technologies. Therefore
we deviate from normal SemVer in the following ways:**
* Any release may update the design, look-and-feel, or branding of an existing
icon
* We will never intentionally release a `patch` version update that breaks
backward compatibility
* A `minor` release **may include backward-incompatible changes** but we will
write clear upgrading instructions in UPGRADING.md
* A `minor` or `patch` release will never remove icons
* Bug fixes will be addressed as `patch` releases unless they include backward
incompability then they will be `minor` releases
## Copyright and License
The icons, code, and assets included in project are licensed under the Font Awesome Pro commercial license - see [this project's license file](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) for details.
## Questions and Contact Us
Font Awesome Pro received backing by thousands of people (thanks again!). With that said, addressing each and every question is a lot of work and the more the community and documentation can help each other, the more we can use that time to focus on getting Pro features out. If you do need to reach out to us, here's how to do it:
@@ -58,22 +72,11 @@ Font Awesome Pro received backing by thousands of people (thanks again!). With t
* **Account/Billing-related inquiries** - email hello@fontawesome.com
* **Questions about [our Kickstarter](https://www.kickstarter.com/projects/232193852/font-awesome-5) campaign** - If you are a backer (thanks, btw!), please reply to individual updates or send a message through Kickstarter.
## Versioning
Font Awesome Pro will be maintained under the [Semantic Versioning guidelines](http://semver.org) as much as possible. Releases will be numbered
with the following format:
`<major>.<minor>.<patch>`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes, changes to brand logos, and misc changes bumps the patch
## Copyright and License
The icons, code, and assets included in project are licensed under the Font Awesome Pro commercial license - see [this project's license file](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) for details.
## Team
[<img src="https://img.fortawesome.com/349cfdf6/dave-pixelated-800.png" alt="" height="100">](https://github.com/davegandy) | [<img src="https://img.fortawesome.com/349cfdf6/travis-pixelated-800.png" alt="" height="100">](https://github.com/supercodepoet) | [<img src="https://img.fortawesome.com/349cfdf6/rob-pixelated-800.png" alt="" height="100">](https://github.com/robmadole) | [<img src="https://img.fortawesome.com/349cfdf6/brian-pixelated-800.png" alt="" height="100">](https://github.com/talbs)
---|---|---|---
[Dave Gandy](https://github.com/davegandy) | [Travis Chase](https://github.com/supercodepoet) | [Rob Madole](https://github.com/robmadole) | [Brian Talbot](https://github.com/talbs)
* [Dave Gandy](https://github.com/davegandy)
* [Travis Chase](https://github.com/supercodepoet)
* [Rob Madole](https://github.com/robmadole)
* [Brian Talbot](https://github.com/talbs)
* [Jory Raphael](https://github.com/sensibleworld)
* [Mike Wilkerson](https://github.com/mlwilkerson)