From 52b7c1fe4db79e52c09944ce43a276a710641036 Mon Sep 17 00:00:00 2001 From: Welding Torch <46340124+Welding-Torch@users.noreply.github.com> Date: Tue, 29 Aug 2023 21:06:06 +0530 Subject: [PATCH] Improve README.md and add Install Instructions. (#53) * Improve README.md and add Install Instructions. * Update README.md --------- Co-authored-by: Lin Yu-Chieh (Victor) --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index eb1b825..ecc3a1d 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,20 @@ [![GitHub all releases](https://img.shields.io/github/downloads/lin-ycv/EverythingPowerToys/total)](https://github.com/lin-ycv/EverythingPowerToys/releases/) [![GitHub release (latest by date)](https://img.shields.io/github/downloads/lin-ycv/everythingpowertoys/latest/total)](https://github.com/lin-ycv/EverythingPowerToys/releases/latest) +This plugin adds Everything search results to PowerToys Run.
+This repo is to be used with the [PowerToys repo](https://github.com/microsoft/PowerToys), this will not compile when used standalone, as it's missing references from PowerToys.
+Dev instructions are in the wiki. -This repo is to be used with the [PowerToys repo](https://github.com/microsoft/PowerToys), this will not compile when used standalone, as it's missing references from PowerToys. Instructions are in the wiki. +#### Install instructions +1. Download the latest release from [here](https://github.com/lin-ycv/EverythingPowerToys/releases/latest). +2. Unzip. +3. Copy the `Everything` folder to `C:\Program Files\PowerToys\RunPlugins` or `%LOCALAPPDATA%\PowerToys\RunPlugins`. +4. Restart PowerToys. -The [release](https://github.com/lin-ycv/EverythingPowerToys/releases) is the compiled result of this repo, extract the downloaded folder to `C:\Program Files\PowerToys\RunPlugins` - -[Everything](https://www.voidtools.com/downloads/) has to be downloaded seperately, and be running in order for this plugin to work.
-**\*This does not work with the lite version of Everything, it does not support IPC**
-*if you are on 1.5 alpha, you need to [Disable 1.5a Instance](http://www.voidtools.com/forum/viewtopic.php?f=12&t=9799#instance)* +#### Requirements +* [PowerToys](https://learn.microsoft.com/en-us/windows/powertoys/) +* [Everything]([https://www.voidtools.com/](https://github.com/lin-ycv/EverythingPowerToys/releases)) (non-lite version) needs to be installed separately and **running**. + * *if you are on 1.5 alpha, you need to [Disable 1.5a Instance](http://www.voidtools.com/forum/viewtopic.php?f=12&t=9799#instance)* [![Stargazers over time](https://starchart.cc/lin-ycv/EverythingPowerToys.svg)](https://starchart.cc/lin-ycv/EverythingPowerToys)