Skip to content

Commit 3e70e05

Browse files
PnwcomputersPnwcomputers
authored
Revise installation guide with structured requirements
Updated the installation guide to include a structured format for system requirements and installation methods. Added details on portable USB deployment and folder structure.
1 parent b5d611a commit 3e70e05

1 file changed

Lines changed: 135 additions & 21 deletions

File tree

‎docs/INSTALLATION.md‎

Lines changed: 135 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,141 @@
22

33
## System Requirements
44

5-
### Minimum Requirements
6-
- **Operating System**: Windows 10 (1909) or Windows 11
7-
- **PowerShell**: Version 5.1 or later
8-
- **RAM**: 4 GB minimum, 8 GB recommended
9-
- **Storage**: 2 GB free space for applications
10-
- **Network**: Internet connection for WinGet packages
11-
12-
### Recommended Requirements
13-
- **PowerShell**: Version 7.x for best performance
14-
- **RAM**: 16 GB for development workstations
15-
- **Storage**: SSD for faster deployment
16-
- **Network**: Broadband connection (10+ Mbps)
17-
18-
## Installation Methods
19-
20-
### Method 1: Direct Download
21-
1. Download the latest release from GitHub
22-
2. Extract to desired location
23-
3. Run as Administrator
24-
25-
### Method 2: Git Clone
5+
| Requirement | Minimum | Recommended |
6+
|-------------|---------|-------------|
7+
| OS | Windows 10 (1909) | Windows 11 |
8+
| PowerShell | 5.1 | 5.1 (ships with Windows) |
9+
| RAM | 4 GB | 8 GB+ |
10+
| Free disk space | 500 MB (tools + reports) | 1 GB |
11+
| Privileges | Standard user (limited) | Administrator (full test suite) |
12+
| Internet | Optional | Required for first-time tool download |
13+
14+
Administrator rights are required for: DISM/SFC scans, energy reports, SMART data, Windows Update queries, and some handle/process tests.
15+
16+
---
17+
18+
## Method 1: Batch Launcher (Recommended)
19+
20+
1. Download or clone this repository to any location (USB drive, local folder, network share)
21+
2. Run `SystemTester.bat` — it will request admin elevation automatically
22+
3. Choose **Option 5** to download the Sysinternals Suite (~35 MB) on first use
23+
4. Choose **Option 1** (interactive menu) or **Option 2** (run all tests automatically)
24+
25+
The batch launcher handles elevation, execution policy, and tool detection. No installation or system modification required.
26+
27+
---
28+
29+
## Method 2: Direct PowerShell
30+
31+
```powershell
32+
# Interactive menu
33+
powershell -ExecutionPolicy Bypass -File .\SystemTester.ps1
34+
35+
# Run all tests automatically and generate reports
36+
powershell -ExecutionPolicy Bypass -File .\SystemTester.ps1 -AutoRun
37+
```
38+
39+
If you see an execution policy error, run this once:
40+
```powershell
41+
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
42+
```
43+
44+
---
45+
46+
## Method 3: Git Clone
47+
2648
```bash
2749
git clone https://github.com/Pnwcomputers/SystemTester.git
2850
cd SystemTester
51+
```
52+
53+
Then run `SystemTester.bat` or invoke the PS1 directly.
54+
55+
---
56+
57+
## First-Time Sysinternals Setup
58+
59+
SystemTester requires the Sysinternals Suite for most tests.
60+
61+
**Automatic (recommended):**
62+
Use batch launcher **Menu Option 5** — downloads directly from Microsoft, VPN-compatible.
63+
64+
**Manual:**
65+
1. Download from [live.sysinternals.com](https://live.sysinternals.com) or the [Microsoft Store page](https://docs.microsoft.com/sysinternals)
66+
2. Extract all `.exe` files to `.\Sysinternals\` next to `SystemTester.ps1`
67+
68+
Minimum required tools for full test coverage:
69+
70+
| Tool | Required For |
71+
|------|-------------|
72+
| `psinfo.exe` | System information |
73+
| `coreinfo.exe` | CPU architecture |
74+
| `pslist.exe` | Process analysis |
75+
| `handle.exe` | File handle scan |
76+
| `psping.exe` | Network latency |
77+
| `autorunsc.exe` | Security / autorun scan |
78+
| `du.exe` | Disk usage |
79+
| `clockres.exe` | Clock resolution |
80+
| `contig.exe` | Disk fragmentation |
81+
82+
All other tools in the suite are used if present and gracefully skipped if absent.
83+
84+
---
85+
86+
## Optional GPU Tools
87+
88+
GPU stress testing tools are not required but extend testing capability.
89+
90+
Use batch launcher **Menu Option 6 → Option 5** to auto-download MSI Afterburner and FurMark directly to the `Tools\` folder.
91+
92+
Or download manually:
93+
- **GPU-Z**: [techpowerup.com/gpuz](https://www.techpowerup.com/gpuz/)
94+
- **MSI Afterburner**: msi.com/Landing/afterburner
95+
- **FurMark**: [geeks3d.com/furmark](https://geeks3d.com/furmark)
96+
- **HWiNFO64**: [hwinfo.com](https://www.hwinfo.com)
97+
98+
Place downloaded tools in the `Tools\` subfolder next to `SystemTester.ps1`.
99+
100+
---
101+
102+
## Portable USB Deployment
103+
104+
SystemTester is designed for USB deployment:
105+
106+
1. Copy the entire repository folder to a USB drive
107+
2. Ensure the drive is formatted as NTFS or exFAT (FAT32 limits file size and may be read-only)
108+
3. Run `SystemTester.bat` directly from the USB
109+
4. Reports are saved to `<USB drive>\SystemTester\Reports\`
110+
111+
The script auto-detects its own location and never writes outside its own directory tree.
112+
113+
---
114+
115+
## Folder Structure
116+
117+
```
118+
SystemTester/
119+
+-- SystemTester.ps1 # Main PowerShell script
120+
+-- SystemTester.bat # Batch launcher (start here)
121+
+-- README.md
122+
+-- LICENSE
123+
+-- Sysinternals/ # Auto-created by launcher Option 5
124+
| +-- psinfo.exe
125+
| +-- psping.exe
126+
| +-- autorunsc.exe
127+
| +-- ... (60+ tools)
128+
+-- Tools/ # GPU testing tools (optional)
129+
| +-- GPU-Z.exe
130+
| +-- MSIAfterburnerSetup.zip
131+
| +-- FurMark_Setup.exe
132+
+-- Reports/ # Auto-created on first report run
133+
+-- SystemTest_Clean_20260622_112034.txt
134+
+-- SystemTest_Detailed_20260622_112034.txt
135+
+-- energy-report.html
136+
```
137+
138+
---
139+
140+
## Uninstall
141+
142+
Delete the folder. SystemTester makes no registry changes, installs no services, and creates no files outside its own directory. Sysinternals tools may leave EULA acceptance entries in `HKCU\Software\Sysinternals\` — delete these manually if desired.

0 commit comments

Comments
 (0)