linux/nerd-fonts
0
0
Fork 0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-09-12 09:41:47 +02:00
Code Issues Projects Releases Wiki Activity

Update contributing.md

Browse source 
* Divides adding new font section into readable steps
This commit is contained in:
Ryan L McIntyre 2017-04-21 23:46:22 -04:00 committed by GitHub
parent b073adc0a8
commit 2ed88f653e
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
contributing.md
View file

@ -10,20 +10,27 @@ Work In Progress, for now the minimum:
* Use sensible commit messages
* If your PR fixes a separate issue number, include it in the commit message
## Adding a new font or removing an existing font
## Steps for adding a new font or removing an existing font
* For removal of font skipt to Step #4
### 1. License
* Check the license even allows the font to be modified and shared
* Add the original (unpatched) version of the font and any readme and/or license files to the `unpatched-sample-fonts` directory inside a new directory
### 2. Add original (unpatched) version
* Add the unpatched version of the font and any readme and/or license files to the `unpatched-sample-fonts` directory inside a new directory
* e.g. Adding *XYZ Font*, create directory `src/unpatched-fonts/xyz/{PUT FONT FILES HERE}`
### 3. Basic testing
* Do a basic test with the new font to ensure it patches correctly and generates a new font file, e.g.
* `./font-patcher src/unpatched-fonts/XYZ/XYZ.ttf --complete`
* Make sure to then delete this new font file if it is in the repository (all patched fonts should be generated in the `patched-fonts` directory)
### 4. Run build scripts
* When fairly satisfied the font patches correctly, run the following scripts in this order:
* Copy all the unpatched readmes to the patched location with additional info on variations appended:
* `./standardize-and-complete-readmes.sh`
* Patch **all** of the variations/options, e.g.
* `./gotta-patch-em-all-font-patcher\!.sh XYZ`
* Add the new font to the README table of supported fonts
### 5. Update readme
* Add the new font to the readme table of supported fonts
* Update the "counts" in the [Features Section][]
* You can get this information by simply passing a second param to the "all patcher": `./gotta-patch-em-all-font-patcher\!.sh "" info`
* "`X` already patched font families" -> Give exact number from 'typefaces' line