From ceb2d87630c3c17063564342274ecaa3b4d357d7 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:51 +0200 Subject: [PATCH 1/3] Standardize README landing page --- README.md | 77 ++++++------------------------------------------------- 1 file changed, 8 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 22e2735..e37aac8 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,27 @@ # Fonts -This is a PowerShell module for managing fonts. -It helps you to install, uninstall and list fonts on the system. - -This module only provides the functionality to manage fonts on the system. To install popular fonts on the system, -please review the [NerdFonts](https://github.com/PSModule/NerdFonts) and [GoogleFonts](https://github.com/PSModule/GoogleFonts) modules. - -## Supported platforms - -This module supports managing fonts on Linux, macOS and Windows operating systems. +Fonts is a PowerShell module for managing fonts. ## Installation -To install the module simply run the following command in a PowerShell terminal. +Install the module from the PowerShell Gallery: ```powershell Install-PSResource -Name Fonts Import-Module -Name Fonts ``` -## Usage - -You can use this module to install, uninstall and list fonts on your system. - -### List installed fonts - -This command will list all fonts installed in the user context. - -```powershell -Get-Font -``` - -This command will list all fonts installed in the system context. -For Windows this means that it will list all fonts installed on the `C:\Windows\Fonts` folder. - -```powershell -Get-Font -Scope AllUsers -``` - -### Install a font - -To install a font in the user context, you can use the following command. -This will install the font in the users font folder `$env:LOCALAPPDATA\Microsoft\Windows\Fonts` and update the registry to -make it available to the current user. - -```powershell -Install-Font -Path 'C:\path\to\font.ttf' -``` - -To install a font on the system you can use the following command. This will need to be run as an administrator. -This will install the font in the `C:\Windows\Fonts` folder and update the registry to make it available to all users on the system. +## Documentation -```powershell -Install-Font -Path 'C:\path\to\font.ttf' -Scope AllUsers -``` +Documentation is published at [psmodule.io/Fonts](https://psmodule.io/Fonts/). -### Uninstall a font - -To uninstall a font from the user context, you can use the following command. -This will remove the font from the users font folder `$env:LOCALAPPDATA\Microsoft\Windows\Fonts` and update the -registry to remove it from the current user. +Use PowerShell help and command discovery for module details: ```powershell -Uninstall-Font -Name 'FontName' # You can tab complete the font name -``` - -To uninstall a font from the system you can use the following command. This will need to be run as an administrator. -This will remove the font from the `C:\Windows\Fonts` folder and update the registry to remove it from all users on the system. - -```powershell -Uninstall-Font -Name 'FontName' -Scope AllUsers # You can tab complete the font name +Get-Command -Module Fonts +Get-Help -Examples ``` ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. -Please see the issues tab on this project and submit a new issue that matches your needs. - -### For Developers - -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From d962918f3b3d6a539bf4c69f9f2ac4abcacff2bd Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:36:43 +0200 Subject: [PATCH 2/3] Restore usage showcase and platform notes; fix help snippet; drop Contributing --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e37aac8..130cdd8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Fonts -Fonts is a PowerShell module for managing fonts. +Fonts is a PowerShell module for managing fonts. It helps you install, uninstall, and list fonts on the system. + +This module only provides the functionality to manage fonts on the system. To install popular fonts, review the +[NerdFonts](https://github.com/PSModule/NerdFonts) and [GoogleFonts](https://github.com/PSModule/GoogleFonts) modules. + +## Supported platforms + +This module supports managing fonts on Linux, macOS, and Windows operating systems. ## Installation @@ -11,6 +18,56 @@ Install-PSResource -Name Fonts Import-Module -Name Fonts ``` +## Usage + +Use the module to list, install, and uninstall fonts on your system. + +### Example: List installed fonts + +List all fonts installed in the current user context: + +```powershell +Get-Font +``` + +List all fonts installed in the system context. On Windows this lists the fonts in the `C:\Windows\Fonts` folder: + +```powershell +Get-Font -Scope AllUsers +``` + +### Example: Install a font + +Install a font in the current user context. This installs the font in the user font folder and updates the +registry so it is available to the current user: + +```powershell +Install-Font -Path 'C:\path\to\font.ttf' +``` + +Install a font for all users. This must run as an administrator, installs the font in the `C:\Windows\Fonts` +folder, and updates the registry so it is available to every user on the system: + +```powershell +Install-Font -Path 'C:\path\to\font.ttf' -Scope AllUsers +``` + +### Example: Uninstall a font + +Uninstall a font from the current user context. This removes the font from the user font folder and updates the +registry to remove it from the current user: + +```powershell +Uninstall-Font -Name 'FontName' +``` + +Uninstall a font for all users. This must run as an administrator, removes the font from the `C:\Windows\Fonts` +folder, and updates the registry to remove it from every user on the system: + +```powershell +Uninstall-Font -Name 'FontName' -Scope AllUsers +``` + ## Documentation Documentation is published at [psmodule.io/Fonts](https://psmodule.io/Fonts/). @@ -19,9 +76,5 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module Fonts -Get-Help -Examples +Get-Help -Name Install-Font -Examples ``` - -## Contributing - -Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 08f974da8d84fb7d240d7b9b7fa8d17af0e55d49 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Jul 2026 11:40:23 +0200 Subject: [PATCH 3/3] Scope Windows registry details and use platform-neutral font paths --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 130cdd8..751067b 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,21 @@ Import-Module -Name Fonts ## Usage -Use the module to list, install, and uninstall fonts on your system. +Use the module to list, install, and uninstall fonts on your system. Fonts are managed for the current user by +default; pass `-Scope AllUsers` to manage fonts for every user, which requires elevated privileges (administrator +on Windows, root on Linux and macOS). On Windows the module also registers or unregisters fonts in the Windows +registry so applications can find them; on Linux and macOS it manages the font files in the appropriate font +directories. ### Example: List installed fonts -List all fonts installed in the current user context: +List all fonts installed for the current user: ```powershell Get-Font ``` -List all fonts installed in the system context. On Windows this lists the fonts in the `C:\Windows\Fonts` folder: +List all fonts installed for all users: ```powershell Get-Font -Scope AllUsers @@ -38,31 +42,27 @@ Get-Font -Scope AllUsers ### Example: Install a font -Install a font in the current user context. This installs the font in the user font folder and updates the -registry so it is available to the current user: +Install a font for the current user: ```powershell -Install-Font -Path 'C:\path\to\font.ttf' +Install-Font -Path ./MyFont.ttf ``` -Install a font for all users. This must run as an administrator, installs the font in the `C:\Windows\Fonts` -folder, and updates the registry so it is available to every user on the system: +Install a font for all users (requires elevated privileges): ```powershell -Install-Font -Path 'C:\path\to\font.ttf' -Scope AllUsers +Install-Font -Path ./MyFont.ttf -Scope AllUsers ``` ### Example: Uninstall a font -Uninstall a font from the current user context. This removes the font from the user font folder and updates the -registry to remove it from the current user: +Uninstall a font for the current user: ```powershell Uninstall-Font -Name 'FontName' ``` -Uninstall a font for all users. This must run as an administrator, removes the font from the `C:\Windows\Fonts` -folder, and updates the registry to remove it from every user on the system: +Uninstall a font for all users (requires elevated privileges): ```powershell Uninstall-Font -Name 'FontName' -Scope AllUsers