Update documentation to reflect new project structure

This commit is contained in:
Alphaeus Mote
2025-04-28 20:04:52 -04:00
parent 1ffbaa4fa9
commit 1a75ff9aa7
6 changed files with 257 additions and 180 deletions
+53 -1
View File
@@ -2,6 +2,14 @@
PSProxmox is a C#-based PowerShell module for managing Proxmox VE clusters. It provides a comprehensive set of cmdlets for interacting with Proxmox VE API, featuring structured return objects, mass deployment tools, automatic IP management, and more.
## Project Structure
- **Module/**: Contains the PowerShell module files
- **PSProxmox/**: Contains the C# source code for the module
- **Documentation/**: Contains detailed documentation and examples
- **Scripts/**: Contains build and installation scripts
- **Release/**: Contains built releases (created by build script)
## Features
- **Session Management**: Authenticate and persist sessions with Proxmox VE clusters
@@ -29,12 +37,32 @@ PSProxmox is a C#-based PowerShell module for managing Proxmox VE clusters. It p
- PowerShell 5.1 or PowerShell 7+
- .NET Framework 4.7.2 or .NET Core 2.0+
## Quick Start
## Installation
### From PowerShell Gallery (Recommended)
```powershell
# Install from PowerShell Gallery
Install-Module -Name PSProxmox -Scope CurrentUser
```
### Manual Installation
```powershell
# Clone the repository
git clone https://github.com/freedbygrace/PSProxmox.git
cd PSProxmox
# Build the module
.\Scripts\build.ps1
# Install the module
.\Scripts\Install-PSProxmox.ps1
```
## Quick Start
```powershell
# Import the module
Import-Module PSProxmox
@@ -67,6 +95,30 @@ For detailed documentation on each cmdlet, you can:
4. Read the [Guides](guides/README.md) for comprehensive guides on various topics.
## Development
### Building the Module
To build the module from source:
```powershell
# Run the build script
.\Scripts\build.ps1
```
This will:
1. Compile the C# code
2. Create a versioned release in the Release folder
3. Update the Module folder with the latest build
4. Create a ZIP package for distribution
### Project Organization
- **C# Source Code**: All C# source code is in the PSProxmox folder
- **PowerShell Module**: The PowerShell module files are in the Module folder
- **Documentation**: Comprehensive documentation is in the Documentation folder
- **Scripts**: Build and installation scripts are in the Scripts folder
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
+25 -5
View File
@@ -25,9 +25,9 @@ If you want to install it for all users on the system, run the following command
Install-Module -Name PSProxmox -Scope AllUsers
```
### Method 2: Install from GitHub
### Method 2: Install from GitHub Release
You can also install the PSProxmox module directly from GitHub:
You can also install the PSProxmox module directly from a GitHub release:
1. Download the latest release from the [GitHub repository](https://github.com/freedbygrace/PSProxmox/releases)
2. Extract the ZIP file
@@ -37,7 +37,27 @@ You can also install the PSProxmox module directly from GitHub:
.\Install-PSProxmox.ps1
```
### Method 3: Manual Installation
### Method 3: Build and Install from Source
You can build and install the PSProxmox module from source:
1. Clone the repository:
```powershell
git clone https://github.com/freedbygrace/PSProxmox.git
cd PSProxmox
```
2. Build the module:
```powershell
.\Scripts\build.ps1
```
3. Install the module:
```powershell
.\Scripts\Install-PSProxmox.ps1
```
### Method 4: Manual Installation
You can manually install the PSProxmox module by copying the files to your PowerShell modules directory:
@@ -47,12 +67,12 @@ You can manually install the PSProxmox module by copying the files to your Power
For Windows PowerShell:
```powershell
Copy-Item -Path .\PSProxmox-Dist\* -Destination "$env:USERPROFILE\Documents\WindowsPowerShell\Modules\PSProxmox" -Recurse -Force
Copy-Item -Path .\* -Destination "$env:USERPROFILE\Documents\WindowsPowerShell\Modules\PSProxmox" -Recurse -Force
```
For PowerShell Core:
```powershell
Copy-Item -Path .\PSProxmox-Dist\* -Destination "$env:USERPROFILE\Documents\PowerShell\Modules\PSProxmox" -Recurse -Force
Copy-Item -Path .\* -Destination "$env:USERPROFILE\Documents\PowerShell\Modules\PSProxmox" -Recurse -Force
```
## Verifying the Installation