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) <victorlin@gapps.ntust.edu.tw>
This commit is contained in:
Welding Torch 2023-08-29 21:06:06 +05:30 committed by GitHub
parent e113bcc848
commit 52b7c1fe4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.<br>
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.<br>
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.<br>
**\*This does not work with the lite version of Everything, it does not support IPC**<br>
*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)