Skip to content

docs: clarify Pro icons metadata setup (icons.json vs icon-families.json) #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kingdomseed wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify Pro icons metadata setup (icons.json vs icon-families.json) #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,18 @@ a public github repository or other public file sharing services.

* Go to the location of your custom font_awesome_flutter version (see [setup](#setup))
* Download the desktop version of font awesome pro and open it
* Move **all** `.otf` files from the `otfs` directory and `icons.json` from `metadata` to
* Move **all** `.otf` files from the `otfs` directory to
`path/to/your/font_awesome_flutter/lib/fonts`. Replace existing files.
* To prevent issues with the web and testing, make sure to **replace spaces in the filenames with dashes**.
* Newer versions might have an `icon-families.json`. If this is the case,
move its contents to `path/to/your/font_awesome_flutter/lib/fonts/icons.json`.
* To prevent issues with the web and testing, **replace spaces in filenames with dashes**
(e.g. `Font Awesome 7 Pro-Solid-900.otf` → `Font-Awesome-7-Pro-Solid-900.otf`).
* For metadata: copy **one** of these files from `metadata/` to `lib/fonts/icons.json`:
* `icons.json` – smaller, uses `styles` format. Use this when it exists and has content.
* `icon-families.json` – uses `svgs` format, includes `familyStylesByLicense`. Use this if
`icons.json` is empty, or if you prefer the richer format.
* **Important**: Copy or rename the chosen file so it becomes `lib/fonts/icons.json`. Do **not**
merge the two files or paste content between them—they are alternative formats for the same
icon set. Full Pro metadata can exceed 100 MB; use [Git LFS](https://git-lfs.github.com/) if
you need it in your repo for CI.
* Run the configurator. It should say "Custom icons.json found"

It may be required to run `flutter clean` in apps who use this version for changes to appear.
Expand Down
Loading