/ README.md
README.md
1 # Fork Awesome 2 ### A fork of the iconic font and CSS toolkit 3 4 [![npm-badge]][npm-link] [![all-contrib]](CONTRIBUTORS.md) [![jsdeliver-badge]][jsdeliver-link] [![cdnjs-badge]][cdnjs-link] [![build-status-badge]][build-status-link] [![matrix-badge]][matrix-link] 5 6 **Fork Awesome is a suite of 796 pictographic and brand icons for easy, scalable vector graphics on websites and beyond.** 7 8 This project, as the name suggests, began as a fork of [Font Awesome](https://fontawesome.com). Font Awesome was originally created by [Dave Gandy](https://twitter.com/davegandy) and ran as a community project. However, as Font Awesome developed, pull requests from the community stopped being accepted (October 2016) and as of version 5.0 [the build system became private](https://github.com/FortAwesome/Font-Awesome/issues/12199#issuecomment-362919956) (February 2018). 9 10 With gratitude to Dave Gandy and the Font Awesome team, [Julien](https://github.com/xuv) [Deswaef](https://merveilles.town/@xuv) forked Font Awesome 4.7 into [Fork Awesome 1.0](https://github.com/ForkAwesome/Fork-Awesome/releases/tag/1.0.0) in February 2018, to continue building the amazing resource in a fully free, libre and open-source fashion, with and for the wider community. After a period of extended inactivity (i.e. no release since February 2019), several Fork Awesome users [got](https://github.com/ForkAwesome/Fork-Awesome/issues/292) [together](https://github.com/ForkAwesome/Fork-Awesome/issues/235) to try and revive the project 🌱 11 12 We are now catching up with backlogged issues and pull requests, updating technology and documentation — even reevaluating the project aims, as icon fonts gradually [become](https://www.irigoyen.dev/blog/2021/02/17/stop-using-icon-fonts/) [deprecated](https://cloudfour.com/thinks/seriously-dont-use-icon-fonts/). Come say hi in the [#forkawesome:matrix.org](https://matrix.to/#/#forkawesome:matrix.org) matrix room 🙂 13 14 ## How to use 15 There is a full page in our documentation website that explains [how to use Fork Awesome in your web project](https://forkaweso.me/Fork-Awesome/get-started/). 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. 16 17 ## License 18 - The Fork Awesome font is licensed under the SIL OFL 1.1: 19 - http://scripts.sil.org/OFL 20 - Fork Awesome CSS, LESS, and Sass files are licensed under the MIT License: 21 - https://opensource.org/licenses/mit-license.html 22 - The Fork Awesome documentation is licensed under the CC BY 3.0 License: 23 - https://creativecommons.org/licenses/by/3.0/ 24 25 ## Contributing 26 27 Please read through our [contributing guidelines](https://github.com/ForkAwesome/Fork-Awesome/blob/master/CONTRIBUTING.md). 28 Included are directions for opening issues, coding standards, and notes on development. 29 30 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](CONTRIBUTORS.md). 31 32 ## Versioning 33 34 Fork Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered 35 with the following format: 36 37 `<major>.<minor>.<patch>` 38 39 And constructed with the following guidelines: 40 41 * Breaking backward compatibility bumps the major (and resets the minor and patch) 42 * Big changes, without breaking backward compatibility, bumps the minor (and resets the patch) 43 * Bug fixes, small adaptations, adding a few icons and misc changes bumps the patch 44 * The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)). 45 * The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7 46 47 For more information on SemVer, please visit http://semver.org. 48 49 ## Building Fork Awesome 50 51 **Before you can build the project**, you must first have the following installed: 52 53 - [Ruby](https://www.ruby-lang.org/en/) 54 - Ruby Development Headers 55 - **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)* 56 - **Windows:** [DevKit](http://rubyinstaller.org/) 57 - **macOS:** no extra step required 58 - [Bundler](http://bundler.io/) (Run `gem install bundler` to install). 59 - [Node Package Manager (aka. `npm`)](https://docs.npmjs.com/getting-started/installing-node) 60 - Tools required to build the font: 61 - **Ubuntu:** `sudo apt-get install fontforge woff-tools woff2` 62 63 From the root of the repository, install the tools used to develop. 64 65 $ bundle install 66 $ npm ci 67 68 Build the font: 69 70 $ make -C src/icons 71 72 Build the web documentation: 73 74 $ npm run build 75 76 Or serve it on a local server on http://localhost:7998: 77 78 $ npm run dev 79 80 ### Build the font in a Docker container 81 82 Another possibility is to build the font using the Dockerfile provided. 83 84 First, build the Docker image: 85 86 $ docker build -t fa-builder . 87 88 Then, run the Docker container: 89 90 $ docker run --rm -it \ 91 -u $(id -u):$(id -g) \ 92 -v $(pwd):$(pwd) \ 93 -w $(pwd) \ 94 fa-builder 95 96 Within the container, build the font: 97 98 $ bundle install --path vendor/bundle 99 $ npm ci 100 $ make -C src/icons 101 102 <!--- reference links for badges --> 103 [all-contrib]: https://img.shields.io/badge/all_contributors-128-orange.svg "All Contributors badge" 104 [build-status-badge]: https://travis-ci.org/ForkAwesome/Fork-Awesome.svg?branch=master "Build status badge" 105 [build-status-link]: https://travis-ci.org/ForkAwesome/Fork-Awesome 106 [cdnjs-badge]: https://img.shields.io/cdnjs/v/fork-awesome.svg "CDNJS badge" 107 [cdnjs-link]: https://cdnjs.com/libraries/fork-awesome 108 [jsdeliver-badge]: https://img.shields.io/jsdelivr/npm/hm/fork-awesome "JSDeliver badge" 109 [jsdeliver-link]: https://www.jsdelivr.com/package/npm/fork-awesome 110 [npm-badge]: https://img.shields.io/npm/v/fork-awesome.svg?colorB=CB3837 "NPM badge" 111 [npm-link]: https://www.npmjs.com/package/fork-awesome 112 [matrix-badge]: https://img.shields.io/matrix/forkawesome:matrix.org?label=%23forkawesome%3Amatrix.org "chat (matrix) badge" 113 [matrix-link]: https://matrix.to/#/#forkawesome:matrix.org