readme improvements

master
Ondřej Hruška 6 years ago
parent 6c2f0daf69
commit 729bda401e
Signed by: MightyPork
GPG Key ID: 2C5FD5035250423D
  1. 27
      README.md

@ -1,10 +1,18 @@
# Fork-Awesome customizer # Fork-Awesome customizer
This is a little hack to let you generate custom Fork-Awesome builds with only a subset of icons. This is a little hack that lets you generate custom Fork-Awesome builds with only a subset of icons.
![screenshot](screenshot.png) ![screenshot](screenshot.png)
## How to use ## 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. 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` - You can fix that by running `git submodule init` and `git submodule update`
@ -13,9 +21,24 @@ This is a little hack to let you generate custom Fork-Awesome builds with only a
- You can update Fork-Awesome and these files at any time by running `./install.sh` again. - 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. 4. Copy either of the "wanted" templates to `wanted.ini`, and customize it as needed.
- Lines starting with `#` will be excluded. - 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. - 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. 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. 6. Run `./build.sh` to build your customized font.
7. Retrieve your output files from the `output/` directory. 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 --- --- EOF ---

Loading…
Cancel
Save