|
1 | 1 | #  |
2 | 2 |
|
3 | | -## Enterprise App Packaging, Extended. |
| 3 | +## 🚀 Enterprise App Packaging, Extended |
4 | 4 |
|
5 | 5 | PSAppDeployToolkit.Tools is a companion module for [PSAppDeployToolkit](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit) that provides tools and functions useful during the application packaging process. Having this separate allows for a separate release schedule and also reduces the file size of the module that is required to be delivered to endpoints to handle software deployments. |
6 | 6 |
|
7 | | -### Features |
| 7 | +### ✨ Key Features |
8 | 8 |
|
9 | | -- **Test-ADTCompatibility** - Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4. |
10 | | -- **Convert-ADTDeployment** - Convert a PSAppDeployToolkit v3 script or an entire package folder to v4 standards. |
| 9 | +- **Test-ADTCompatibility** - Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4.1. |
| 10 | +- **Convert-ADTDeployment** - Convert a PSAppDeployToolkit v3 script or an entire package folder to v4.1 standards. |
11 | 11 |
|
12 | | -## Getting Started |
| 12 | +## 🚀 Getting Started |
| 13 | + |
| 14 | +### Prerequisites |
| 15 | + |
| 16 | +- Windows 10/11 |
| 17 | +- PowerShell 5.1 or later |
| 18 | +- .NET Framework 4.7.2 or later |
| 19 | + |
| 20 | +### Installing The Module |
13 | 21 |
|
14 | 22 | Install the module from the PowerShell Gallery: |
15 | 23 |
|
16 | 24 | ```powershell |
17 | 25 | Install-Module PSAppDeployToolkit.Tools -Scope CurrentUser -AllowPreRelease |
18 | 26 | ``` |
19 | 27 |
|
20 | | -If this produces an error that the `-AllowPreRelease` parameter is not recognised, then first update PowerShellGet and then restart your PowerShell console: |
| 28 | +If this produces an error that the `-AllowPreRelease` parameter is not recognized, then first update PowerShellGet and then restart your PowerShell console: |
21 | 29 |
|
22 | 30 | ```powershell |
23 | 31 | Install-Module PowerShellGet -Force -Scope CurrentUser |
@@ -49,22 +57,29 @@ Convert-ADTDeployment -Path .\PackageFolder |
49 | 57 |
|
50 | 58 | This example converts PackageFolder into PackageFolder_Converted in the same folder. |
51 | 59 |
|
52 | | -### PSAppDeployToolkit Links |
| 60 | +## 📄 License |
| 61 | + |
| 62 | +This project is licensed under the [GNU Lesser General Public License](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/blob/main/COPYING.Lesser) |
| 63 | + |
| 64 | +## Important Links |
53 | 65 |
|
54 | | --> [Homepage](https://psappdeploytoolkit.com) |
55 | | --> [Documentation](https://psappdeploytoolkit.com/docs) |
56 | | --> [Function & Variable References](https://psappdeploytoolkit.com/docs/reference) |
57 | | --> [Download Latest Release](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/releases) |
58 | | --> [News](https://psappdeploytoolkit.com/blog) |
| 66 | +### PSAppDeployToolkit |
59 | 67 |
|
60 | | -### Community Links |
| 68 | +- [Homepage](https://psappdeploytoolkit.com) |
| 69 | +- [Latest News](https://psappdeploytoolkit.com/blog) |
| 70 | +- [Documentation](https://psappdeploytoolkit.com/docs/introduction) |
| 71 | +- [Function & Variable References](https://psappdeploytoolkit.com/docs/reference) |
| 72 | +- [PowerShell Gallery](https://www.powershellgallery.com/packages/PSAppDeployToolkit) |
| 73 | +- [GitHub Releases](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/releases) |
61 | 74 |
|
62 | | --> [Discourse Forum](https://discourse.psappdeploytoolkit.com/) |
63 | | --> [Discord Chat](https://discord.com/channels/618712310185197588/627204361545842688) |
64 | | --> [Reddit](https://reddit.com/r/psadt) |
| 75 | +### Community |
65 | 76 |
|
66 | | -## License |
| 77 | +- [Discourse Forum](https://discourse.psappdeploytoolkit.com/) |
| 78 | +- [Discord Chat](https://discord.com/channels/618712310185197588/627204361545842688) |
| 79 | +- [Reddit](https://reddit.com/r/psadt) |
67 | 80 |
|
68 | | -The PowerShell App Deployment Tool is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. |
| 81 | +### GitHub |
69 | 82 |
|
70 | | -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. |
| 83 | +- [Issues](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/issues) |
| 84 | +- [Security Policy](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/security) |
| 85 | +- [Contributor Guidelines](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/blob/main/.github/CONTRIBUTING.md) |
0 commit comments