Skip to content

Commit ceb2d87

Browse files
Standardize README landing page
1 parent d665c51 commit ceb2d87

1 file changed

Lines changed: 8 additions & 69 deletions

File tree

README.md

Lines changed: 8 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,27 @@
11
# Fonts
22

3-
This is a PowerShell module for managing fonts.
4-
It helps you to install, uninstall and list fonts on the system.
5-
6-
This module only provides the functionality to manage fonts on the system. To install popular fonts on the system,
7-
please review the [NerdFonts](https://github.com/PSModule/NerdFonts) and [GoogleFonts](https://github.com/PSModule/GoogleFonts) modules.
8-
9-
## Supported platforms
10-
11-
This module supports managing fonts on Linux, macOS and Windows operating systems.
3+
Fonts is a PowerShell module for managing fonts.
124

135
## Installation
146

15-
To install the module simply run the following command in a PowerShell terminal.
7+
Install the module from the PowerShell Gallery:
168

179
```powershell
1810
Install-PSResource -Name Fonts
1911
Import-Module -Name Fonts
2012
```
2113

22-
## Usage
23-
24-
You can use this module to install, uninstall and list fonts on your system.
25-
26-
### List installed fonts
27-
28-
This command will list all fonts installed in the user context.
29-
30-
```powershell
31-
Get-Font
32-
```
33-
34-
This command will list all fonts installed in the system context.
35-
For Windows this means that it will list all fonts installed on the `C:\Windows\Fonts` folder.
36-
37-
```powershell
38-
Get-Font -Scope AllUsers
39-
```
40-
41-
### Install a font
42-
43-
To install a font in the user context, you can use the following command.
44-
This will install the font in the users font folder `$env:LOCALAPPDATA\Microsoft\Windows\Fonts` and update the registry to
45-
make it available to the current user.
46-
47-
```powershell
48-
Install-Font -Path 'C:\path\to\font.ttf'
49-
```
50-
51-
To install a font on the system you can use the following command. This will need to be run as an administrator.
52-
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.
14+
## Documentation
5315

54-
```powershell
55-
Install-Font -Path 'C:\path\to\font.ttf' -Scope AllUsers
56-
```
16+
Documentation is published at [psmodule.io/Fonts](https://psmodule.io/Fonts/).
5717

58-
### Uninstall a font
59-
60-
To uninstall a font from the user context, you can use the following command.
61-
This will remove the font from the users font folder `$env:LOCALAPPDATA\Microsoft\Windows\Fonts` and update the
62-
registry to remove it from the current user.
18+
Use PowerShell help and command discovery for module details:
6319

6420
```powershell
65-
Uninstall-Font -Name 'FontName' # You can tab complete the font name
66-
```
67-
68-
To uninstall a font from the system you can use the following command. This will need to be run as an administrator.
69-
This will remove the font from the `C:\Windows\Fonts` folder and update the registry to remove it from all users on the system.
70-
71-
```powershell
72-
Uninstall-Font -Name 'FontName' -Scope AllUsers # You can tab complete the font name
21+
Get-Command -Module Fonts
22+
Get-Help <CommandName> -Examples
7323
```
7424

7525
## Contributing
7626

77-
Coder or not, you can contribute to the project! We welcome all contributions.
78-
79-
### For Users
80-
81-
If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
82-
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
83-
Please see the issues tab on this project and submit a new issue that matches your needs.
84-
85-
### For Developers
86-
87-
If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
88-
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.
27+
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

0 commit comments

Comments
 (0)