A fork of the iconic font and CSS toolkit (Font-Awesome 4.7)
Clone or download
tessus Merge pull request #130 from waldyrious/patch-1
README: minor rewording fix
Latest commit 9a147d2 Oct 31, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE create a template for Icon Requests Oct 15, 2018
css New version nubmer just to trigger CI Oct 15, 2018
fonts Adds fa-gitea icon. Fixes #107 Oct 15, 2018
less New version nubmer just to trigger CI Oct 15, 2018
scss New version nubmer just to trigger CI Oct 15, 2018
src README.md: add badge for npm version - this time the correct file ;-) Oct 15, 2018
.all-contributorsrc Adding @jerrykan on the contributor list Oct 8, 2018
.gitignore add swap and backup files to .gitignore Mar 23, 2018
.npmignore .npmignore: add .github/ Oct 16, 2018
.travis.yml Should deploy also to NPM on tags Sep 25, 2018
CHANGELOG.md Bumps version number Oct 15, 2018
CONTRIBUTING.md Update CONTRIBUTING.md fix build instructions link Aug 31, 2018
CONTRIBUTORS.md Adding @jerrykan on the contributor list Oct 8, 2018
Gemfile Revert to a version of Jekyll that works Sep 23, 2018
Gemfile.lock Revert to a version of Jekyll that works Sep 23, 2018
LICENSES Adds the full license text at root of project for all 3 licenses Oct 2, 2018
README.md README: minor rewording fix Oct 30, 2018
_config-deploy.yml Updating version info to 1.1.0 May 12, 2018
_config.yml New version nubmer just to trigger CI Oct 15, 2018
bower.json Updating bower Feb 8, 2018
component.json Preparing for release Sep 25, 2018
composer.json Update package version to 1.0.1 Feb 18, 2018
package-lock.json add icon: C fa-c Oct 15, 2018
package.json New version nubmer just to trigger CI Oct 15, 2018

README.md

Fork Awesome

A fork of the iconic font and CSS toolkit

npm All Contributors JSDeliver CDNJS Build Status

Fork Awesome is a full suite of 733 pictographic icons for easy scalable vector graphics on websites, originally created by Dave Gandy and now maintained by a community.

Following concerns regarding the development of Font Awesome, the PR Freeze since Oct 2016 and the direction Fort Awesome is taking with the version 5.0 of their project, we are forking Font Awesome (4.7), in order to build on this amazing tool Dave Gandy has given us, while at the same time allowing this project to be run by a distributed community of contributors.

A tremendous gratitude is given to the whole team behind Font Awesome, and you are encouraged to support them and buy Font Awesome Pro for your project.

That said, if you believe in distributed open source design and wish to be part of this new adventure, please start submitting patches and suggestions of improvement.

Also, if you care about owning the build process of your icon font, this project will give you that. The whole pipeline is shared and free to use for any purpose. You could be spinning your own icon font with your clever name by just forking this project and changing a few settings.

How to use

There is a full page in our documentation website that explains how to use Fork Awesome in your web project. It ranges from just pointing to a CSS file on a CDN, hosting it on your own server or even adapting the LESS and SCSS files to your own liking.

License

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

We also take great pride in recognizing any contributions made to this project. Whether you've written a blogpost about it, fixed a typo in the documentation or submitted new icons or code patches, we will happily list you in our contributors list.

Versioning

Fork Awesome will be maintained under the Semantic Versioning guidelines 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)
  • Big changes, without breaking backward compatibility, bumps the minor (and resets the patch)
  • Bug fixes, small adaptations, adding a few icons and misc changes bumps the patch
  • The fork started from FontAwesome 4.7 (last commit by Dave is bdfa9823).
  • The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7

For more information on SemVer, please visit http://semver.org.

Component

To include as a component, just run

$ component install ForkAwesome/Fork-Awesome

Or add

"ForkAwesome/Fork-Awesome": "*"

to the dependencies in your component.json.

Building Fork Awesome

Before you can build the project, you must first have the following installed:

From the root of the repository, install the tools used to develop.

$ bundle install
$ npm install

Build the font:

$:/src/icons make

Build the web documentation:

$ npm run build

Or serve it on a local server on http://localhost:7998:

$ npm run dev