PeterDocs/Docs/Install.md

31 lines
767 B
Markdown
Raw Normal View History

2021-07-25 12:22:13 +00:00
# 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
2021-07-25 14:02:06 +00:00
When you install ```PeterDocs``` from the PowerShell Gallery, the
required dependencies are installed for you
2021-07-25 12:22:13 +00:00
2021-07-25 14:02:06 +00:00
Execute the following command to install the module under the current user
2021-07-25 12:22:13 +00:00
```powershell
2021-07-25 14:02:06 +00:00
Install-Module -Name PeterDocs -Scope CurrentUser
2021-07-25 12:22:13 +00:00
```
2021-07-25 14:02:06 +00:00
Execute the following command to install the module for all users. You will
2021-07-25 12:22:13 +00:00
need administrator rights.
```powershell
2021-07-25 14:02:06 +00:00
Install-Module -Name PeterDocs -Scope AllUsers
2021-07-25 12:22:13 +00:00
```
## Compress Usage
Please read next the documentation on [creating an archive file](Compress.md)