diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..cf6837935 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +--- + +## [0.1.0](https://github.com/FortAwesome/Font-Awesome-Pro/tree/v0.1.0) - 2017-01-20 + +### Added +* initial repo/project infrastructure + +--- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..13e81b099 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing to Font Awesome Pro + + +## Reporting Issues +Found a problem with Font Awesome Pro? Feel free to submit an issue on the GitHub project. But please keep the following in mind: + +1. Please be nice. Font Awesome is a happy place. +2. Please [search](https://github.com/FortAwesome/Font-Awesome-Pro/search?type=Issues) to see if your issue was already reported. If it was, join in on the conversation or upvote that issue. +3. Before opening any issue, please read the generic [issue guidelines](https://github.com/necolas/issue-guidelines), by Nicolas Gallagher. +4. After doing everything above, feel free to [submit an issue](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new). + +Please do not report security issues in public. Please email hello@fontawesome.com. + +## Solve a bug in Font Awesome Pro? Want to contribute new features? Here are a few things to remember: + +1. Please do not submit new icons. +2. Please submit all pull requests against `*-wip` branches. +3. All pull requests submitted against master will be summarily closed and this guide referenced. +4. After doing everything above, feel free to [submit a pull request](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new). + +## Key Branches +- `master` is the latest, deployed version (use for pull request if they only affect the docs) +- `*-wip` branches are the official work in progress branches for the next releases. All pull requests should be submitted against the appropriate branch + +## Community + +### Expectations We Have of You + +1. You'll be nice to and courteous of everyone involved in the project, including your peers (again, Font Awesome is a happy place). +2. You will not distribute or use the icons, code, or assets in this project in a way that violates the [Font Awesome Pro Commercial license](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md). This includes selling the plans to Old Slugworth. + +### Expectations You Have of Us + +1. We'll be nice, courteous, and prompt when responding in discussions and in sending updates. +2. We'll be pretty nerdy and funny when we can. Sorry, not sorry. :P + +## Pull Requests +- At the moment we are not accepting pull requests containing icons +- Submit all pull requests against the appropriate `*-wip` branch for easier merging +- If your PR only affect the docs, feel free to push against the `master` branch +- Try not to pollute your pull request with unintended changes--keep them simple and small + + +## Coding standards + + +## License +By contributing your code, you agree to license your contribution under the terms of the the [Font Awesome Pro Commercial license](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) and the terms of the [MIT License](http://opensource.org/licenses/mit-license.html) for any contributions that are made open source as development progresses. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..b2da1cbbd --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,32 @@ +# Font Awesome 5 Pro Commercial License + +--- + +**NOTE**: Font Awesome icons, features, and code that are shared between Font Awesome 5 Free and Pro versions will eventually be moved to more open licenses as development progresses. + +## Personal / Small Business License +* Covers individuals or small businesses with up to 100 employees. +* License follows the person or business. +* If the project is for personal use, the person should have a license. If the project is for a business, the business should have a license. +* Use on as many projects (web app/site, iOS app, etc.) as you like. +* Don’t use in a theme or re-distribute. +* License is transferable. +* For greater than 100 employees, buy multiple small business licenses. Enterprise licenses are available for up to 3,000 employees (see below). + +## Student / Non-Profit License +* Covers individual students for personal projects OR non-profit organizations of any size. +* Use on as many projects (web app/site, iOS app, etc.) as you like. +* Don’t use in a theme or re-distribute. +* License is transferable. + +## Enterprise / Company License +* Covers companies up to 3,000 employees. +* License follows the company. If the project is for personal use, the person should have a license. If the project is for a company, the company should have a license. +* Use on as many projects (web app/site, iOS app, etc.) as you like. +* Don’t use in a theme or re-distribute. +* For greater than 3,000 employees, buy multiple enterprise licenses. + +## Theme License +* Allows use in a single theme that you can re-sell. For multiple themes, buy multiple licenses. +* Cannot re-distribute Font Awesome Pro except embedded in your theme. +* Grants a single personal / small business license for theme buyer to use Font Awesome Pro as a part of your theme (not outside). diff --git a/README.md b/README.md index 995b4983f..2a99785f1 100644 --- a/README.md +++ b/README.md @@ -1 +1,43 @@ -# Font-Awesome-Pro \ No newline at end of file +

Font Awesome 5

+ +The internet's most popular icon is being redesigned and built from scratch. on top of this, Font Awesome Pro adds thousands more icons and features like icon font ligatures, an SVG framework, community voting/support, and access to a new CDN. + +Not familiar with Font Awesome 5? [Learn more](https://www.kickstarter.com/projects/232193852/font-awesome-5) about our successful Kickstarter and plan. You can also **[pre-order your copy of Font Awesome Pro](http://five.fontawesome.io/)** and save off of the release price. + + +## 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). + + +## 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. + + +## 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: + +* **General/Business inquiries** - email hello@fontawesome.com +* **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: + +`..` + +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 +[](https://github.com/davegandy) | [](https://github.com/supercodepoet) | [](https://github.com/robmadole) | [](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)