|
1 | 1 | # GoogleFonts |
2 | 2 |
|
3 | | -This is a PowerShell module for installing GoogleFonts on your system. This module and repository does not contain the fonts themselves, |
4 | | -but rather a way to install them on your system. |
5 | | - |
6 | | -🎉 Kudos to the GoogleFonts community for keeping the library going! 🎉 |
7 | | -For any issues with the fonts themselves, please refer to the [GoogleFonts](https://github.com/google/fonts) repository. |
8 | | - |
9 | | -## Prerequisites |
10 | | - |
11 | | -This module depends on the [Fonts](https://psmodule.io/Fonts) module to manage fonts on the system. |
| 3 | +GoogleFonts is a PowerShell module for downloading and installing fonts from Google Fonts. |
12 | 4 |
|
13 | 5 | ## Installation |
14 | 6 |
|
15 | | -To install the module simply run the following command in a PowerShell terminal. |
| 7 | +Install the module from the PowerShell Gallery: |
16 | 8 |
|
17 | 9 | ```powershell |
18 | 10 | Install-PSResource -Name GoogleFonts |
19 | 11 | Import-Module -Name GoogleFonts |
20 | 12 | ``` |
21 | 13 |
|
22 | | -## Usage |
23 | | - |
24 | | -### Install a GoogleFont |
25 | | - |
26 | | -To install a GoogleFont on the system you can use the following command. |
27 | | - |
28 | | -```powershell |
29 | | -Install-GoogleFont -Name 'Roboto' # Tab completion works on name |
30 | | -``` |
31 | | - |
32 | | -To download the font from the GoogleFonts repository and install it on the system, run the following command. |
33 | | - |
34 | | -```powershell |
35 | | -Install-GoogleFont -Name 'Roboto' -Scope AllUsers #Tab completion works on Scope too |
36 | | -``` |
37 | | - |
38 | | -### Install all GoogleFonts |
39 | | - |
40 | | -To install all GoogleFonts on the system you can use the following command. |
| 14 | +## Documentation |
41 | 15 |
|
42 | | -This will download and install all GoogleFonts to the current user. |
43 | | -```powershell |
44 | | -Install-GoogleFont -All |
45 | | -``` |
| 16 | +Documentation is published at [psmodule.io/GoogleFonts](https://psmodule.io/GoogleFonts/). |
46 | 17 |
|
47 | | -To install all GoogleFonts on the system for all users, run the following command. |
48 | | -This requires the shell to run in an elevated context (sudo or run as administrator). |
| 18 | +Use PowerShell help and command discovery for module details: |
49 | 19 |
|
50 | 20 | ```powershell |
51 | | -Install-GoogleFont -All -Scope AllUsers |
| 21 | +Get-Command -Module GoogleFonts |
| 22 | +Get-Help <CommandName> -Examples |
52 | 23 | ``` |
53 | 24 |
|
54 | 25 | ## Contributing |
55 | 26 |
|
56 | | -Coder or not, you can contribute to the project! We welcome all contributions. |
57 | | - |
58 | | -### For Users |
59 | | - |
60 | | -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the |
61 | | -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. |
62 | | -Please see the issues tab on this project and submit a new issue that matches your needs. |
63 | | - |
64 | | -### For Developers |
65 | | - |
66 | | -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. |
67 | | -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. |
68 | | - |
69 | | -## Links |
70 | | - |
71 | | -- GoogleFonts | [GitHub](https://github.com/google/fonts) | [Web](https://fonts.google.com/) |
| 27 | +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. |
0 commit comments