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

Add links, mention SVG use, add build warning/workaround

Browse Source
This commit is contained in:
Doug Webb 2021-07-24 18:52:14 +02:00 committed by GitHub
parent 137c8b52d1
commit 14bab3353d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,14 +7,16 @@
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). 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).
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 🌱 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](https://fontawesome.com/v4.7/) ([v4.7.0 source](https://github.com/FortAwesome/Font-Awesome/releases/tag/v4.7.0)) 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 🌱
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 🙂 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 🙂
## How to use ## How to use
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. 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.
## License It is also possible to use the icons directly as SVG. They are located in [`src/icons/svg`](https://github.com/ForkAwesome/Fork-Awesome/tree/master/src/icons/svg). We don't have accompanying documentation for this usage yet.
## Licenses
- The Fork Awesome font is licensed under the SIL OFL 1.1: - The Fork Awesome font is licensed under the SIL OFL 1.1:
- http://scripts.sil.org/OFL - http://scripts.sil.org/OFL
- Fork Awesome CSS, LESS, and Sass files are licensed under the MIT License: - Fork Awesome CSS, LESS, and Sass files are licensed under the MIT License:
@ -23,15 +25,13 @@ There is a full page in our documentation website that explains [how to use Fork
- https://creativecommons.org/licenses/by/3.0/ - https://creativecommons.org/licenses/by/3.0/
## Contributing ## Contributing
Please read through our [contributing guidelines](https://github.com/ForkAwesome/Fork-Awesome/blob/master/CONTRIBUTING.md). Please read through our [contributing guidelines](https://github.com/ForkAwesome/Fork-Awesome/blob/master/CONTRIBUTING.md).
Included are directions for opening issues, coding standards, and notes on development. 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](CONTRIBUTORS.md). 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).
## Versioning ## Versioning
Fork Awesome will be maintained under the [Semantic Versioning guidelines](https://semver.org/) as far as possible. Releases will be numbered
Fork Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
with the following format: with the following format:
`<major>.<minor>.<patch>` `<major>.<minor>.<patch>`
@ -44,8 +44,6 @@ And constructed with the following guidelines:
* The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)). * The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)).
* The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7 * 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 ## Component
To include as a [component](https://github.com/componentjs/component), just run To include as a [component](https://github.com/componentjs/component), just run
@ -59,6 +57,8 @@ to the `dependencies` in your `component.json`.
## Building Fork Awesome ## Building Fork Awesome
⚠️ The Fork Awesome build process has been neglected for some time. The instructions below seem to work for modern Linux installations as far as building the fonts, but not building the site. One repeatable workaround is to follow the instructions using [Ubuntu 18.04](https://releases.ubuntu.com/18.04/ubuntu-18.04.5-desktop-amd64.iso), optionally within a [VirtualBox Virtual Machine](https://www.virtualbox.org/). We're working on it... ⚠️
**Before you can build the project**, you must first have the following installed: **Before you can build the project**, you must first have the following installed:
- [Ruby](https://www.ruby-lang.org/en/) - [Ruby](https://www.ruby-lang.org/en/)