packages/generator-react-native-vector-icons/src/app/templates/README.md
<%= name %> font for React Native Vector Icons
See the React Native Vector Icons README for more details.
<% if (copyCustomFonts) { -%>
[!IMPORTANT] This package does not include the fonts. You must provide them yourself.
<% } -%>
npm install @react-native-vector-icons/<%= packageName %>
<% if (copyCustomFonts) { -%>
This package requires you to provide the font files. Place your .ttf font
file in the following location:
rnvi-fonts/<%= packageName %>/<%= fontFileName %>.ttf
The font will be automatically copied during the build process for both iOS and Android.
<% } -%>
import { <%= className %> } from '@react-native-vector-icons/<%= packageName %>';
// ...
<<%= className %> name="house" color="#ff0000" size={20} />
<% if (versionTable) { -%>
Prior to version 12, the version of this font package tracked the upstream version.
The table below tracks which font version is included in each package version.
| RNVI version | Upstream version |
|---|---|
| <%= versionTable %> |
<% } -%>
See the contributing guide to learn how to contribute to the repository and the development workflow.
MIT