diff --git a/README.md b/README.md index 75913ac..9cd5030 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Install-NerdFont -Name 'FiraCode' -Scope AllUsers #Tab completion works on Scope To install all NerdFonts on the system you can use the following command. This will download and install all NerdFonts to the current user. + ```powershell Install-NerdFont -All ``` @@ -53,6 +54,60 @@ This requires the shell to run in an elevated context (sudo or run as administra Install-NerdFont -All -Scope AllUsers ``` +### Check if a NerdFont is installed + +The [Fonts](https://psmodule.io/Fonts) module is installed automatically as a dependency and provides the +[`Get-Font`](https://psmodule.io/Fonts/Functions/Get-Font/) command for querying installed fonts on the system. + +To check if a specific NerdFont is installed for the current user: + +```powershell +Get-Font -Name 'FiraCode*' +``` + +To check across all users on the system: + +```powershell +Get-Font -Name 'FiraCode*' -Scope AllUsers +``` + +If the command returns results, the font is installed. If it returns nothing, the font is not installed in that scope. + +### Update an installed NerdFont + +Individual font files do not embed a NerdFonts release version, so there is no direct way to check whether an installed +NerdFont is outdated. To ensure you have the version bundled with the module, reinstall the font using the `-Force` parameter: + +```powershell +Install-NerdFont -Name 'FiraCode' -Force +``` + +If the font was originally installed for all users, update it with the matching scope (requires elevated privileges): + +```powershell +Install-NerdFont -Name 'FiraCode' -Force -Scope AllUsers +``` + +This re-downloads and installs the font version bundled with your installed NerdFonts module, overwriting any existing +files. To pick up newer font releases, update the NerdFonts module first (`Update-Module -Name NerdFonts`). + +### Uninstall a NerdFont + +To uninstall a NerdFont, use the [`Uninstall-Font`](https://psmodule.io/Fonts/Functions/Uninstall-Font/) command +from the [Fonts](https://psmodule.io/Fonts) module (installed automatically as a dependency). + +To uninstall a NerdFont from the current user: + +```powershell +Uninstall-Font -Name 'FiraCode*' # Tab completion works on name +``` + +To uninstall a NerdFont for all users (requires elevated privileges): + +```powershell +Uninstall-Font -Name 'FiraCode*' -Scope AllUsers +``` + ## Contributing Coder or not, you can contribute to the project! We welcome all contributions.