A fork of the iconic font and CSS toolkit

Julien Deswaef 66b346f2a9 Updates less-plugin-clean-css for security reasons hace 5 años
.github 7a0461f290 Redefining use cases hace 6 años
css 8c73f16ee2 Updates all the packages related to less for security reasons hace 5 años
fonts 013f290c40 Updates config of svgo hace 5 años
less 486649d509 Solves issues with appearance of Tor and Volume-mute icons. Fixes #240 hace 5 años
scss 486649d509 Solves issues with appearance of Tor and Volume-mute icons. Fixes #240 hace 5 años
src 013f290c40 Updates config of svgo hace 5 años
.all-contributorsrc b005c60b21 docs: update .all-contributorsrc [skip ci] hace 5 años
.gitignore 99a389b2ef add swap and backup files to .gitignore hace 7 años
.npmignore 22d1b36260 .npmignore: add .github/ hace 6 años
.travis.yml 5a2ca8e6ea Should deploy also to NPM on tags hace 6 años
CHANGELOG.md c14e361ccb Bumping the version number for release of 1.1.6 hace 6 años
CONTRIBUTING.md 38de667bc2 Update CONTRIBUTING.md fix build instructions link hace 7 años
CONTRIBUTORS.md 5338f06b09 docs: update CONTRIBUTORS.md [skip ci] hace 5 años
Gemfile 11f664e762 Revert to a version of Jekyll that works hace 6 años
Gemfile.lock 11f664e762 Revert to a version of Jekyll that works hace 6 años
LICENSES b8f88fce7f Adds the full license text at root of project for all 3 licenses hace 6 años
README.md 8c73f16ee2 Updates all the packages related to less for security reasons hace 5 años
_config-deploy.yml 7b5eb3856f Adds the official domain name hace 6 años
_config.yml 326af9c8be Preparing release of version 1.1.7 hace 6 años
bower.json fc81f003b1 Updating bower hace 7 años
component.json 326af9c8be Preparing release of version 1.1.7 hace 6 años
composer.json d9ef6d01d0 Update package version to 1.0.1 hace 7 años
package-lock.json 66b346f2a9 Updates less-plugin-clean-css for security reasons hace 5 años
package.json 66b346f2a9 Updates less-plugin-clean-css for security reasons hace 5 años

README.md

Fork Awesome

A fork of the iconic font and CSS toolkit

npm-badge all-contrib jsdeliver-badge cdnjs-badge build-status-badge

Fork Awesome is a full suite of 758 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.

Though 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 ci

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