Go to file
Julien Deswaef dcd5bfdb58 Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
css Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
fonts Merge branch 'master' of github.com:ForkAwesome/Fork-Awesome 2018-02-24 13:28:34 -05:00
fork-awesome Update Medium icon 2018-02-24 11:29:51 -06:00
less Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
scss Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
src Generating sourcemap files for fork-awesome.min.css 2018-02-24 13:56:53 -05:00
.gitignore Simplification of on the ignoring parts 2018-02-22 17:58:44 -05:00
.npmignore Simplification of on the ignoring parts 2018-02-22 17:58:44 -05:00
CHANGELOG.md Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
CONTRIBUTING.md Updating meta-data of packages 2018-02-05 23:41:51 -05:00
Gemfile As long as Less and Less-plugin installed in global, this is not necessary for deploying 2018-02-22 18:54:47 -05:00
Gemfile.lock Update Medium icon 2018-02-24 11:29:51 -06:00
README.md Update Medium icon 2018-02-24 11:29:51 -06:00
_config-deploy.yml Moved the documentation site to its own src/subfolder 2018-02-12 20:19:20 -05:00
_config.yml Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
bower.json Updating bower 2018-02-08 17:48:17 -05:00
component.json Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00
composer.json Update package version to 1.0.1 2018-02-18 16:30:34 -05:00
package-lock.json Update Medium icon 2018-02-24 11:29:51 -06:00
package.json Bumping version to 1.0.7 2018-02-24 14:07:39 -05:00

README.md

Fork Awesome

A fork of the iconic font and CSS toolkit

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

License

Contributing

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

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)
  • 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
  • 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.

Original author of Font Awesome:

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 on 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/Fork-Awesome/:

$ npm run dev

To deploy the project and documentation on GH pages:

$ jgd -n