|
|
|
|
# Fork-Awesome customizer
|
|
|
|
|
|
|
|
|
|
This is a little hack that lets you generate custom Fork-Awesome builds with only a subset of icons.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
Mostly dependencies of the Fork-Awesome project:
|
|
|
|
|
|
|
|
|
|
- `ruby`, `bundle` (package may be named `ruby-bundler`)
|
|
|
|
|
- `node`
|
|
|
|
|
- `bash`, `make`, `sed`, `head`, `cat`
|
|
|
|
|
|
|
|
|
|
## How to use it
|
|
|
|
|
|
|
|
|
|
1. Make sure you cloned this repository recursively, i.e. the `Fork-Awesome/` folder is not empty.
|
|
|
|
|
- You can fix that by running `git submodule init` and `git submodule update`
|
|
|
|
|
2. Run `./install.sh`. This should prepare the FA submodule for building the font.
|
|
|
|
|
3. Verify that files `wanted.all.ini`, `wanted.none.ini`, `fontcustom.yml` and `fontcustom.default.yml` have been created.
|
|
|
|
|
- You can update Fork-Awesome and these files at any time by running `./install.sh` again.
|
|
|
|
|
4. Copy either of the "wanted" templates to `wanted.ini`, and customize it as needed.
|
|
|
|
|
- Lines starting with `#` will be excluded.
|
|
|
|
|
- The INI suffix is used only to make editors highlight it nicely, it's not really an INI file
|
|
|
|
|
- Use the [FA icons page](https://forkawesome.github.io/Fork-Awesome/icons/) for reference.
|
|
|
|
|
5. Adjust `fontconfig.yml` if you wish to give your custom font a different name, or change the class prefix.
|
|
|
|
|
6. Run `./build.sh` to build your customized font.
|
|
|
|
|
7. Retrieve your output files from the `output/` directory.
|
|
|
|
|
|
|
|
|
|
The screenshot shown above was built with the following `wanted.ini`:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
fork-awesome
|
|
|
|
|
thumbs-up
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
and some changes in fontcustom.yml:
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
font_name: TinyFork
|
|
|
|
|
css_selector: .lfa-{{glyph}}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
--- EOF ---
|
