clarifications

master
Ondřej Hruška 6 years ago
parent e882d50288
commit d4f821803f
Signed by: MightyPork
GPG Key ID: 2C5FD5035250423D
  1. 10
      README.md
  2. 12
      install.sh
  3. 16
      refresh-templates.sh

@ -9,13 +9,13 @@ This is a little hack to let you generate custom Fork-Awesome builds with only a
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` and `wanted.none.ini` have been created.
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.
- Use the [FA icons page](https://forkawesome.github.io/Fork-Awesome/icons/) for reference.
5. Run `./build.sh` to build your customized font.
6. Retrieve your output files from the `output/` directory.
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.
Note: The "woff" file may fail to build, resulting in the make target in `Fork-Awesome/src/icons` failing.
This shouldn't be a problem, as the fonts are already built.
--- EOF ---

@ -22,4 +22,14 @@ echo ">>> If no errors occured, FA should be ready to build."
echo -e "\x1b[90m(npm complaining about vulnerabilities is probably okay)\x1b[m"
cd ..
bash ./refresh-templates.sh
echo "=== Refreshing templates for building a customized font ==="
rm -rf "./patcher/templates/*"
cp "./Fork-Awesome/src/icons/.fontcustom-manifest.json" "./patcher/templates"
cp "./Fork-Awesome/src/icons/fontcustom.yml" "./patcher/templates"
cp "./Fork-Awesome/src/icons/icons.yml" "./patcher/templates"
cp -R "./Fork-Awesome/src/icons/svg" "./patcher/templates"
(cd ./patcher && node ./refresh-wanted-templates.js)

@ -1,16 +0,0 @@
#!/bin/bash
if [ ! -f "./Fork-Awesome/.git" ]; then
echo -e "\x1b[31;1mFA submodule is not initialized, exit...\x1b[m"
exit
fi
echo "=== Refreshing templates for building a customized font ==="
rm -rf "./patcher/templates/*"
cp "./Fork-Awesome/src/icons/.fontcustom-manifest.json" "./patcher/templates"
cp "./Fork-Awesome/src/icons/fontcustom.yml" "./patcher/templates"
cp "./Fork-Awesome/src/icons/icons.yml" "./patcher/templates"
cp -R "./Fork-Awesome/src/icons/svg" "./patcher/templates"
(cd ./patcher && node ./refresh-wanted-templates.js)
Loading…
Cancel
Save