PeterDocs/Docs/Install.md

31 lines
767 B
Markdown

# Install
PeterDocs is a module that can be donwloaded or installed from
[PowerShell Gallery](https://xx.com/)
## Pre-requisites
PowerShell must be installed before you can use the PeterDocs module.
## Automated install
When you install ```PeterDocs``` from the PowerShell Gallery, the
required dependencies are installed for you
Execute the following command to install the module under the current user
```powershell
Install-Module -Name PeterDocs -Scope CurrentUser
```
Execute the following command to install the module for all users. You will
need administrator rights.
```powershell
Install-Module -Name PeterDocs -Scope AllUsers
```
## Compress Usage
Please read next the documentation on [creating an archive file](Compress.md)