Skip to content

Commit 836bda7

Browse files
tugichtugich
committed
2 parents 79cb7cb + eed5e9e commit 836bda7

File tree

1 file changed

+159
-51
lines changed

1 file changed

+159
-51
lines changed

‎README.md‎

Lines changed: 159 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,174 @@
1-
# DeploymentEditor
2-
Visual Software Packaging Editor by TUGI.CH
1+
# DeploymentEditor
2+
**Visual Software Packaging Editor for PSAppDeployToolkit (PSADT)**
3+
by **TUGI.CH**
34

4-
<!-- ABOUT THE PROJECT -->
5-
## 🧑‍💻 About The Project
6-
**Welcome to the Deployment Editor for PSADT (PSAppDeployToolkit).** This application simplifies the packaging process for all Windows engineers. You can click your sequence for PSADT through the GUI and with just one simple click you get the fully automated coded PowerShell script for the deployment. The best part: It’s free & open-source.<br/><br/>
75
![App Screenshot](Screenshot.png)
86

9-
<!-- GETTING STARTED -->
7+
---
8+
9+
## 🧑‍💻 About the Project
10+
11+
**DeploymentEditor** is a **visual, project-based software packaging editor** designed to dramatically simplify the creation of professional deployment packages using **PSAppDeployToolkit (PSADT)**.
12+
13+
Instead of manually writing and maintaining complex PowerShell deployment scripts, DeploymentEditor allows Windows engineers to **build installation, uninstallation and repair logic visually** through an intuitive GUI.
14+
With just a few clicks, the editor **automatically generates a fully structured, production-ready PowerShell deployment script** that follows PSADT best practices.
15+
16+
### Key Benefits
17+
- 🚀 **Accelerated packaging workflow** – build PSADT packages faster and with fewer errors
18+
- 🧩 **Visual sequence editor** – no deep PowerShell knowledge required
19+
- 📦 **Project-based architecture** – each package is self-contained and portable
20+
- 🛠 **Highly customizable** – templates, commands, and plugins are fully editable
21+
- 🔓 **Free & Open Source** – no licensing costs, no limitations
22+
23+
DeploymentEditor is ideal for:
24+
- Endpoint Management Engineers (Intune, SCCM, MECM)
25+
- Enterprise IT Administrators
26+
- Software Packaging Specialists
27+
- Anyone deploying Windows software at scale
28+
29+
---
30+
1031
## ✅ Getting Started
1132

12-
### Requirements
13-
Windows 10/11 64-bit (It also runs well on ARM-based Windows via the translation layer.)<br/>
14-
PureBasic IDE (to compile the source code if needed, binary is included in each release).
33+
### System Requirements
34+
- **Windows 10 / Windows 11 (64-bit)**
35+
- Fully compatible with **ARM-based Windows** via the Microsoft x64 translation layer
36+
- **PureBasic IDE** (only required if you want to compile the source yourself; precompiled binaries are provided)
37+
38+
### ⚠️ Important: PowerShell Execution Policy (Windows Settings)
39+
DeploymentEditor generates and executes PowerShell scripts based on PSAppDeployToolkit (PSADT).
40+
For this reason, PowerShell script execution must be enabled on the system where packages are built or tested.
1541

1642
### Prerequisites
17-
There are no prerequisites for this tool. All required files are included in this GitHub repository.
18-
19-
### Installation
20-
You can download the latest release from GitHub or use the MSI installer from the releases.<br/>
21-
The editor runs in user context and doesn't require administrator rights. For packaging, you need administrator rights to run a packaging project (in system context).
22-
23-
<!-- TEMPLATE SYSTEM -->
24-
## ✅ (v1.0.7) Project-based templates
25-
There are several templates for each part of the editor. You can customize them and the compiler will take them for each time in the deployment file generation process.
26-
In the latest version (v1.0.7), each project/PSADT package contains its own template (Invoke-AppDeployToolkit.ps1.template) for the final resulting file (Invoke-AppDeployToolkit.ps1).
27-
28-
<!-- FOLDERS AND FILES -->
29-
## 📄 Folders and files
30-
- ***Databases [Folder]:*** PSADT.sql database for defining all commands and parameters.
31-
- ***Examples [Folder]:*** Some basic examples with other software than 7-Zip
32-
- ***Forms [Folder]:*** All forms created with the PureBasic IDE
33-
- ***Plugins [Folder]:*** Built-in editor plugins written in PowerShell
34-
- ***Resources [Folder]:*** Images, icons and more
35-
- ***Scripts [Folder]:*** Some scripts for the development part of the editor
36-
- ***Snippets [Folder]:*** (Not used yet)
37-
- ***Templates [Folder]:*** All templates used by the editor to build any script or file for the final package
38-
- ***Test [Folder]:*** Basic example with 7-Zip installer - ThirdParty: Some third party libraries like PSADT and more
39-
- ***DeploymentEditor.pb [File]:*** The main source file
40-
- ***DeploymentEditor.pbp [File]:*** The project file for the PureBasic IDE
41-
42-
<!-- USAGE EXAMPLES -->
43+
There are **no external prerequisites**.
44+
All required components, templates, databases, and resources are included directly in this repository or the release packages.
45+
46+
---
47+
48+
## 📦 Installation
49+
50+
You have two installation options:
51+
52+
1. **Portable / ZIP Version**
53+
- Download the latest release from GitHub
54+
- Extract and run immediately (no installation required)
55+
56+
2. **MSI Installer**
57+
- Available in the GitHub Releases section (if provided)
58+
- Ideal for managed environments
59+
60+
### Execution Context
61+
- The **editor itself runs in user context** and **does not require administrator privileges**
62+
- **Administrator rights are only required** when executing a packaging project that builds or tests a deployment in **system context**
63+
64+
---
65+
66+
## 🧩 Project-Based Template System (v1.0.7+)
67+
68+
Starting with **version 1.0.7**, DeploymentEditor introduces a **fully project-scoped template system**.
69+
70+
### How It Works
71+
- Each deployment project contains its **own PSADT template**
72+
- Templates are used during compilation to generate the final deployment script
73+
- This allows **maximum flexibility** between different customers, environments, or packaging standards
74+
75+
### Key Template File
76+
- `Invoke-AppDeployToolkit.ps1.template`
77+
→ Compiled into
78+
- `Invoke-AppDeployToolkit.ps1`
79+
80+
This approach ensures:
81+
- No global template conflicts
82+
- Full version control per project
83+
- Clean separation between logic and presentation
84+
85+
---
86+
87+
## 📄 Repository Structure
88+
89+
The repository is organized to clearly separate logic, UI, resources, and extensibility components:
90+
91+
- **Databases/**
92+
PSADT.sql database defining all available commands, parameters, and metadata
93+
94+
- **Examples/**
95+
Sample projects demonstrating packaging workflows beyond 7-Zip
96+
97+
- **Forms/**
98+
All GUI forms created using the PureBasic IDE
99+
100+
- **Plugins/**
101+
Built-in editor plugins written in PowerShell for extended functionality
102+
103+
- **Resources/**
104+
Images, icons, UI assets, and branding resources
105+
106+
- **Scripts/**
107+
Helper scripts used during development of the editor
108+
109+
- **Snippets/**
110+
Reserved for future expansion (currently unused)
111+
112+
- **Templates/**
113+
Core templates used to generate deployment scripts and package files
114+
115+
- **Test/**
116+
Example project using the 7-Zip installer
117+
Includes third-party components such as PSADT
118+
119+
- **DeploymentEditor.pb**
120+
Main PureBasic source file
121+
122+
- **DeploymentEditor.pbp**
123+
PureBasic project file
124+
125+
---
126+
43127
## 📋 Usage
44128

45-
**Video Tutorial on YouTube:**<br/>
46-
[Deployment Editor - Package Softwares with PSAppDeployToolkit (PSADT)](https://www.youtube.com/watch?v=1Ct5B27BGP4)<br/>
47-
There is also an example that shows a simple sequence for installing and uninstalling 7-Zip. Give it a try and if you have any questions just contact me via email or LinkedIn.
129+
### Video Tutorial
130+
📺 **YouTube Walkthrough:**
131+
[Deployment Editor – Package Software with PSAppDeployToolkit (PSADT)](https://www.youtube.com/watch?v=1Ct5B27BGP4)
132+
133+
The tutorial demonstrates:
134+
- Creating a new project
135+
- Building install & uninstall sequences
136+
- Packaging 7-Zip as a real-world example
48137

49-
<!-- COMPILING -->
50-
## ⚙️ Compile for Windows
51-
You need the PureBasic IDE in the latest version to compile the source code for Windows: https://www.purebasic.com.
52-
Just open the DeploymentEditor.pbp file and run the compiler with [F5] - the rest is magic.
138+
If you have questions, feedback, or feature requests, feel free to reach out.
139+
140+
---
141+
142+
## ⚙️ Compiling from Source
143+
144+
To compile DeploymentEditor yourself:
145+
146+
1. Install the **latest version of the PureBasic IDE**
147+
https://www.purebasic.com
148+
2. Open `DeploymentEditor.pbp`
149+
3. Compile and run using **F5**
150+
151+
The build process is fully self-contained — no additional dependencies required.
152+
153+
---
53154

54-
<!-- LICENSE -->
55155
## 📄 License
56-
See `LICENSE.txt` for more information.
57156

58-
<!-- CREDITS -->
59-
## 📄 Credits
60-
[PSAppDeployToolkit/PSAppDeployToolkit](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit)<br/>
61-
See also LICENSE_ThirdParty.txt
157+
This project is licensed under the terms described in `LICENSE.txt`.
158+
159+
---
160+
161+
## 📄 Credits & Third-Party Software
162+
163+
- PSAppDeployToolkit
164+
https://github.com/PSAppDeployToolkit/PSAppDeployToolkit
165+
166+
Additional third-party licenses can be found in `LICENSE_ThirdParty.txt`.
167+
168+
---
62169

63-
<!-- CONTACT -->
64170
## 📧 Contact
65-
TUGI - [contact@tugi.ch](mailto:contact@tugi.ch)<br/>
66-
Project Link: [https://blog.tugi.ch/deployment-editor-preview](https://blog.tugi.ch/deployment-editor-preview)
171+
172+
**TUGI**
173+
📩 Email: [contact@tugi.ch](mailto:contact@tugi.ch)
174+
🌐 Project Page: https://blog.tugi.ch/deployment-editor-preview

0 commit comments

Comments
 (0)