From be3f56af277e2029776a4a68c6269abf6dc0134c Mon Sep 17 00:00:00 2001 From: Homes32 Date: Thu, 11 Jun 2026 22:18:16 -0500 Subject: [PATCH] Update README --- LICENSE | 2 +- README.md | 135 +++++++++++++++++++++++++++++++++++++----------------- 2 files changed, 93 insertions(+), 44 deletions(-) diff --git a/LICENSE b/LICENSE index 2905bb3..4c02e08 100644 --- a/LICENSE +++ b/LICENSE @@ -4,7 +4,7 @@ The PhoenixPE project is distributed under the MIT License. Additional 3rd party tools, encoded files, and programs used by the project are the property of their respective authors and may be subject to their own license agreement. -Copyright (c) 2014-2024 Jonathan Holmgren (Homes32) +Copyright (c) 2014-2026 Jonathan Holmgren (Homes32) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f0861f4..abeac1a 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,125 @@ # PhoenixPE -[![Latest Release](https://img.shields.io/github/release-pre/phoenixpe/phoenixpe.svg?style=flat-square&label=Latest%20Release)](https://github.com/phoenixpe/phoenixpe/releases) +[![Latest Release](https://img.shields.io/github/v/release/PhoenixPE/PhoenixPE)](https://github.com/phoenixpe/phoenixpe/releases) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square&label=License)](https://opensource.org/licenses/MIT) -[![Download Stats](https://img.shields.io/github/downloads/phoenixpe/phoenixpe/total.svg?label=Downloads&style=flat-square)](https://github.com/phoenixpe/phoenixpe/releases) -[![Contributors](https://img.shields.io/github/contributors/phoenixpe/phoenixpe.svg?style=flat-square&label=Contributors)](https://github.com/phoenixpe/phoenixpe/graphs/contributors) +[![Downloads](https://img.shields.io/github/downloads/PhoenixPE/PhoenixPE/total)](https://github.com/phoenixpe/phoenixpe/releases) +[![Contributors](https://img.shields.io/github/contributors/PhoenixPE/PhoenixPE)](https://github.com/phoenixpe/phoenixpe/graphs/contributors) ![PhoenixPE Logo](https://github.com/PhoenixPE/PhoenixPE/blob/master/.github/Images/PhoenixPE.png) -PhoenixPE is a WinPE Rescue/Recovery Environment based on Win10/Win11. It can be booted via USB, CD/DVD, PXE/Network, or hard disk. +> **When your system won't boot, PhoenixPE puts you back in control.** -* PhoenixPE uses the "next-generation" [PEBakery](https://github.com/pebakery/PEBakery) engine resulting in faster build times and advanced features compared to legacy Winbuilder projects. -* Build from Win10/Win11 sources using either boot.wim or WinRE.wim as a base. -* Designed from the ground up to be developer/contributor friendly and use clean, well documented code. -* Easy to understand options and uncluttered user interface. -* Flexible and modular architecture. -* PEBakery's powerful scripting language allows extensive customization. +PhoenixPE is a fully customizable WinPE Rescue and Recovery Environment built on Win10/Win11. Boot it from a USB drive, CD/DVD, PXE, or hard disk — and get access to a powerful suite of recovery, diagnostics, and repair tools without needing a working OS. + +![PhoenixPE main interface screenshot](https://github.com/PhoenixPE/PhoenixPE/blob/master/.github/Images/PhoenixPE-Main.png) + +## Why PhoenixPE? + +PhoenixPE was developed from the ground up to be fast, flexible, and user-friendly. + +- **Next-generation build engine.** Built on [PEBakery](https://github.com/pebakery/PEBakery), delivering faster build times and advanced features that legacy Winbuilder projects simply can't match. +- **Win10 and Win11 source support.** Build from `boot.wim` or `WinRE.wim`. ([Compatible sources](https://github.com/PhoenixPE/PhoenixPE/wiki/Source-Compatibility)) +- **Modular and extensible.** Add your own apps and scripts using PEBakery's clean scripting language and the [PhoenixPE API](https://github.com/PhoenixPE/PhoenixPE/wiki/PhoenixAPI). Most scripts can be updated to a new app version simply by changing a version number. +- **Clean, well-documented code.** Designed from scratch without the decades of hacks, workarounds, and bloat accumulated by older projects. +- **Approachable for all skill levels.** Simple options and an uncluttered UI for everyday use; deep flexibility for power users and developers who want full control. ## Features -* Drive Backup/Clone/Imaging -* Malware Removal -* Password Recovery -* File Recovery -* Forensics Tools -* Drive Partitioning/Install Prep. -* Hardware Diagnostics -* Offline OS Troubleshooting/Repair/Recovery -* And more... +### Recovery & Repair +- Drive backup, cloning, and imaging +- File recovery +- Password recovery +- Offline OS troubleshooting, repair, and recovery -PhoenixPE includes a variety of carefully selected applications to get you started and PEBakery's user friendly scripting language makes it easy for you create your own scripts and customize PhoenixePE with your favorite apps and settings. +### Security +- Malware removal +- Forensics tools -![PhoenixPE Logo](https://github.com/PhoenixPE/PhoenixPE/blob/master/.github/Images/PhoenixPE-Main.png) +### Hardware & Maintenance +- Drive partitioning and install prep +- Hardware diagnostics -![PhoenixPE Logo](https://github.com/PhoenixPE/PhoenixPE/blob/master/.github/Images/PhoenixPE-Win11-01.png) +PhoenixPE ships with a curated selection of well-integrated tools to cover the most common recovery scenarios. Because every user's needs are different, PEBakery's scripting language makes it straightforward to add your favorite applications and settings on top. -## License +## Screenshots -**PhoenixPE** is licensed under the MIT license. Refer to [license](LICENSE) for more information. +![PhoenixPE running on Windows 11](https://github.com/PhoenixPE/PhoenixPE/blob/master/.github/Images/PhoenixPE-Win11-01.png) -## Installation +## Getting Started -Download the [latest release](https://github.com/PhoenixPE/PhoenixPE/releases) and unpack it in the desired location. To uninstall, simply delete the PhoenixPE folder. +**Requirements:** A Windows 10 or Windows 11 host machine, a compatible Win10/Win11 source (see [Compatible Sources](https://github.com/PhoenixPE/PhoenixPE/wiki/Source-Compatibility)), and internet access for the initial build. + +1. **Download** the [latest release](https://github.com/PhoenixPE/PhoenixPE/releases) and unpack it to your desired location. +2. **Launch PEBakery**, point it at your Windows source, and select the scripts you want to include. +3. **Build.** PEBakery will download required tools from the Windows ADK on the first run and cache everything locally — subsequent builds don't need internet access. +4. **Write to media** using Rufus or your preferred tool, or configure your network for PXE boot. +5. **Boot and recover.** + +> **Slow or unreliable internet?** Use the per-script download button in PEBakery to pre-cache app installers before building. You can also place the entire PhoenixPE folder on a USB drive and pre-download files from a faster connection elsewhere. See the [FAQ](https://github.com/PhoenixPE/PhoenixPE/wiki/FAQ#what-if-i-have-slow-internet-or-poor-reliability) for details. + +To uninstall, simply delete the PhoenixPE folder. + +Full build instructions are on the [Building PhoenixPE](https://github.com/PhoenixPE/PhoenixPE/wiki/Building-PhoenixPE) wiki page. + +## Customization & Scripting + +PhoenixPE is developer-friendly and designed to be extended. You can include additional applications, configure app settings at build time, register shell extensions and file handlers, and tailor almost every aspect of the environment to your needs. + +Useful resources for getting started: +- [PEBakery Documentation](https://github.com/pebakery/pebakery-docs) +- [PhoenixPE API](https://github.com/PhoenixPE/PhoenixPE/wiki/PhoenixAPI) +- [Project Variables](https://github.com/PhoenixPE/PhoenixPE/wiki/ProjectVars) + +If you get stuck, the community forums are a great place to ask — there's a good chance someone has already written a script for a similar application. ## Documentation -Documentation is available on the [PhoenixPE Wiki](https://github.com/PhoenixPE/PhoenixPE/wiki). +Full documentation is available on the [PhoenixPE Wiki](https://github.com/PhoenixPE/PhoenixPE/wiki), including: -## Development +- [Building PhoenixPE](https://github.com/PhoenixPE/PhoenixPE/wiki/Building-PhoenixPE) +- [Compatible Sources](https://github.com/PhoenixPE/PhoenixPE/wiki/Source-Compatibility) +- [Security & Antivirus False Positives](https://github.com/PhoenixPE/PhoenixPE/wiki/Security) +- [Frequently Asked Questions](https://github.com/PhoenixPE/PhoenixPE/wiki/FAQ) -PhoenixPE is developed, maintained, and supported by a community of developers/volunteers who enjoy sharing their ideas and work in their free time. +## Common Questions -Interested in contributing to PhoenixPE? Please read our [contributor guidelines](https://github.com/PhoenixPE/PhoenixPE/blob/master/docs/CONTRIBUTING.md). +**Why does my antivirus flag some software in PhoenixPE as a virus?** +This is a known false positive. Recovery tools often use low-level system access that antivirus software flags incorrectly. -Want to create your own scripts, include additional applications, and personalize PhoenixPE to your taste? +See the [Security & Antivirus False Positives](https://github.com/PhoenixPE/PhoenixPE/wiki/Security) page for a full explanation. -Check out the following resources: -* [PEBakery Documentation](https://github.com/pebakery/pebakery-docs) -* [PhoenixPE API](https://github.com/PhoenixPE/PhoenixPE/wiki/PhoenixAPI) +**Why should I choose PhoenixPE instead downloading a popular pre-built ISO?** +Pre-made ISOs like Hiren's, Gandalf's, MediCat, and Sergei are often built on Win10XPE or PhoenixPE projects, but strip out all credit while slapping their own name on the result. They add some fancy graphics and tweaks, but can be bloated and almost always ship with outdated software. -## Enhancements/Bugs +Some sketcher pre-built ISO's hide freely available software behind paywalls, and bundle Warez putting you at legal risk. -Please use the [GitHub issue tracker](https://github.com/PhoenixPE/PhoenixPE/issues) for reporting problems or suggesting new features. +Since you have no visibility into what's actually baked into someone else's ISO, you're trusting a stranger on the internet with a tool that runs with full system access. -## Support +Building PhoenixPE yourself means you control exactly what's included, keep everything current and secure, add your own apps and license keys, and get it all in your native language. Put in a little work and reap the rewards — it's worth the effort. -PhoenixPE is supported by a vibrant community of developers, boot disk/WinPE enthusiasts, and volunteers. Please post general questions and support requests in one of our forums. +**Can I request an application be included?** +It's impossible to bundle every application, and everyone has different needs. Instead, the scripting system makes it easy for *you* to include your favorite applications. Check out the resources above and ask in the forums if you need a hand. -* [The Oven](https://theoven.org/viewforum.php?f=26) -* [MSFN](https://msfn.org/board/topic/187719-phoenixpe-a-modern-rescue-recovery-environment/) +See the full [FAQ](https://github.com/PhoenixPE/PhoenixPE/wiki/FAQ#can-you-include-xyz-application-in-phoneixpe) for more information. -## Frequently Asked Questions (FAQ) +## Contributing -Please check out our [Frequently Asked Questions](https://github.com/PhoenixPE/PhoenixPE/wiki/FAQ) before posting an issue or asking for help in the forums. +PhoenixPE is developed and maintained by a community of volunteers. Contributions of all kinds are welcome. -We also ask that you take the time to read our statement on [Security](https://github.com/PhoenixPE/PhoenixPE/wiki/Security) and [Antivirus False Positives](https://github.com/PhoenixPE/PhoenixPE/wiki/Security). +- Read the [Contributor Guidelines](https://github.com/PhoenixPE/PhoenixPE/blob/master/docs/CONTRIBUTING.md) before submitting. +- Browse [open issues](https://github.com/PhoenixPE/PhoenixPE/issues) to find something to work on. +- Report bugs or suggest features via the [issue tracker](https://github.com/PhoenixPE/PhoenixPE/issues). +- Monitor our forums and share your knowledge and experience with other users. + +## Community & Support + +Get help, share builds, and discuss the project in our forums: + +- [The Oven](https://theoven.org/viewforum.php?f=26) +- [MSFN](https://msfn.org/board/topic/187719-phoenixpe-a-modern-rescue-recovery-environment/) + +Please check the [FAQ](https://github.com/PhoenixPE/PhoenixPE/wiki/FAQ) before posting a new issue or forum question. + +## License + +PhoenixPE is licensed under the [MIT License](LICENSE).