Skip to content

Commit 7ddfbbf

Browse files
Merge pull request #254 from erikdarlingdata/readme-getting-started
Add Getting Started section to README
2 parents d399dee + 36a5ab7 commit 7ddfbbf

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Free, open-source SQL Server performance monitoring in two editions. Built for D
44

55
**Supported SQL Servers:** SQL Server 2016, 2017, 2019, 2022, 2025 | Azure SQL Managed Instance | AWS RDS for SQL Server | Azure SQL Database (Lite only)
66

7-
**Dashboard/Lite requires:** Windows 10 or later, Windows Server 2016 or later
7+
**Dashboard/Lite requires:** Windows 10 or later, Windows Server 2016 or later | [.NET 8 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
8+
9+
**Download ready-to-run executables from the [Releases page](https://github.com/erikdarlingdata/PerformanceMonitor/releases).** No build steps required — download the `.zip` for the edition you want, extract it to any folder, and run the `.exe` inside. See [Getting Started](#getting-started) for setup details.
810

911
---
1012

@@ -95,6 +97,19 @@ A single WPF desktop application that monitors SQL Server instances remotely. Qu
9597

9698
---
9799

100+
## Getting Started
101+
102+
1. Install the [.NET 8 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) if you don't already have it (look for ".NET Desktop Runtime 8.0.x" — not the ASP.NET Core or Server runtime)
103+
2. Go to the [Releases page](https://github.com/erikdarlingdata/PerformanceMonitor/releases) and download the `.zip` for the edition you want:
104+
- **`PerformanceMonitorLite`** — standalone desktop app, no server install needed
105+
- **`PerformanceMonitorInstaller`** — sets up the PerformanceMonitor database and SQL Agent jobs on your server
106+
- **`PerformanceMonitorDashboard`** — desktop app that connects to the database created by the Installer
107+
3. Extract the `.zip` to any folder and run the `.exe` inside
108+
109+
For the **Full Edition**, run the Installer first (see below), then open the Dashboard. For the **Lite Edition**, just run the app — no installation step required.
110+
111+
---
112+
98113
## Quick Start — Full Edition
99114

100115
### Install

0 commit comments

Comments
 (0)