Skip to content

Commit 9fb62bf

Browse files
committed
2 parents c04851f + 0d00f3e commit 9fb62bf

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,18 @@ This example outputs the `System.IO.FileSystemInfo` objects in the current direc
4444
Get-ChildFileSystemItem -AttributeFilter 'Hidden','System'
4545
```
4646

47+
## Installation
48+
49+
### Temporary install (current session)
50+
1. Clone and build the solution
51+
2. Run `Import-Module "<your path here>\DiskCleanupPS.psd1"`
52+
53+
### Permanent install (always loaded)
54+
1. Create a new folder in one of your `$env:PSModulePath` directories (e.g. %USERPROFILE%\Documents\WindowsPowerShell\Modules or %PROGRAMFILES%\WindowsPowerShell\Modules) named DiskCleanupPS.
55+
2. Clone and build the solution.
56+
3. Copy the output files to the new module folder.
57+
4. Open a new PowerShell console or ISE host and run `Get-Command -Module DiskCleanupPS`, you should see the cmdlets listed above.
58+
4759
## Remarks
4860

4961
For those already comfortable with PowerShell scripting concepts (i.e. Functions, Pipeline processing), writing a compiled cmdlet can be a great intro to the C# language, and can provide deeper insight into the PowerShell runtime. The [Windows PowerShell SDK](https://docs.microsoft.com/en-us/powershell/developer/windows-powershell) documentation has several examples to get you started, and pretty good documentation to help you along the way.

0 commit comments

Comments
 (0)