FlandreScarle7/Fork-Awesome
1
0
Fork 0
mirror of https://github.com/ForkAwesome/Fork-Awesome.git synced 2024-12-25 21:11:32 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
DEPRECATED. A fork of the iconic font and CSS toolkit
1,542 Commits 12 Branches 21 Tags 74 MiB
HTML 45.3%
Less 26.4%
SCSS 16.6%
CSS 9.2%
Ruby 1%
Other 1.4%
8f1588c5df
Go to file
todd 8f1588c5df Change travis.yml back to use npm install 
The npm version that is running on travis.ci doesn't support `npm ci`
It looks the easy way to update the npm version is updating the
package-lock.json file.
2019-02-27 19:22:03 -05:00
.github/ISSUE_TEMPLATE Redefining use cases 2018-12-14 13:40:26 -05:00
css Bumping the version number for release of 1.1.6 2019-02-21 10:24:28 -05:00
fonts Bumped the size of the Biometric icon. 2019-02-18 18:31:53 -05:00
less Clean less and scss dirs during build - remove less/font-awesome.less 2019-02-26 16:24:18 -05:00
scss Renamed .scss files so they are handled properly by Jekyll 2019-02-25 05:28:41 -05:00
src Clean less and scss dirs during build - remove less/font-awesome.less 2019-02-26 16:24:18 -05:00
_config-deploy.yml Adds the official domain name 2019-02-18 16:04:46 -05:00
_config.yml Bumping the version number for release of 1.1.6 2019-02-21 10:24:28 -05:00
.all-contributorsrc Adds @fedidat as a contributor 2019-02-19 10:26:43 -05:00
.gitignore add swap and backup files to .gitignore 2018-03-23 14:55:47 -04:00
.npmignore .npmignore: add .github/ 2018-10-16 00:24:43 -04:00
.travis.yml Change travis.yml back to use npm install 2019-02-27 19:22:03 -05:00
bower.json Updating bower 2018-02-08 17:48:17 -05:00
CHANGELOG.md Bumping the version number for release of 1.1.6 2019-02-21 10:24:28 -05:00
component.json Bumping the version number for release of 1.1.6 2019-02-21 10:24:28 -05:00
composer.json Update package version to 1.0.1 2018-02-18 16:30:34 -05:00
CONTRIBUTING.md Update CONTRIBUTING.md fix build instructions link 2018-08-31 11:21:04 -04:00
CONTRIBUTORS.md Adds @fedidat as a contributor 2019-02-19 10:26:43 -05:00
Gemfile Revert to a version of Jekyll that works 2018-09-23 16:17:32 -04:00
Gemfile.lock Revert to a version of Jekyll that works 2018-09-23 16:17:32 -04:00
LICENSES Adds the full license text at root of project for all 3 licenses 2018-10-02 18:41:04 -04:00
package-lock.json Reverted changes to package-lock.json 2019-02-25 05:52:05 -05:00
package.json Bumping the version number for release of 1.1.6 2019-02-21 10:24:28 -05:00
README.md Change npm install to npm ci so lock file is not updated 2019-02-26 16:13:25 -05:00

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 744 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