Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 66 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@
WinQuickLook
</h1>
<p align="center">
A lightweight file viewer like "Quick Look" on macOS.
<strong>Bring macOS Quick Look to Windows</strong>
</p>
<p align="center">
Preview files instantly with a single keystroke—no need to open applications
</p>

<p align="center">
<a href="https://github.com/polymind-inc/WinQuickLook/actions/workflows/build.yml" rel="nofollow"><img src="https://github.com/polymind-inc/WinQuickLook/workflows/Build/badge.svg" alt="Build" style="max-width: 100%;"></a>
<a href="https://github.com/polymind-inc/WinQuickLook/actions/workflows/publish.yml" rel="nofollow"><img src="https://github.com/polymind-inc/WinQuickLook/workflows/Publish/badge.svg" alt="Build" style="max-width: 100%;"></a>
Expand All @@ -16,34 +20,83 @@
<a href="https://github.com/polymind-inc/WinQuickLook/blob/master/LICENSE"><img src="https://badgen.net/github/license/polymind-inc/WinQuickLook" alt="License" style="max-width: 100%;"></a>
</p>

## How to install
---

## ✨ Overview

WinQuickLook is a fast, lightweight file previewer for Windows that brings the beloved macOS Quick Look experience to your PC. Simply select a file in File Explorer and press <kbd>Space</kbd> to instantly preview it—no waiting for applications to launch.

Perfect for quickly browsing through documents, images, videos, and more without the hassle of opening full applications.

### Microsoft Store
## 🎯 Features

- **⚡ Lightning Fast** - Instant file previews without opening heavy applications
- **🎨 Wide Format Support** - Preview images, documents, videos, audio files, and more
- **⌨️ Simple Keyboard Shortcut** - Just press <kbd>Space</kbd> to preview, <kbd>Esc</kbd> to close
- **🪶 Lightweight** - Minimal resource usage, runs quietly in the background
- **🎨 Modern UI** - Clean, intuitive interface that fits seamlessly with Windows
- **🔄 Seamless Integration** - Works directly with Windows File Explorer

## 📦 Installation

### Option 1: Microsoft Store (Recommended)

Get the app directly from the Microsoft Store for automatic updates:

<a href="https://www.microsoft.com/store/apps/9njmtkk6jc0q?cid=storebadge&ocid=badge"><img src="https://developer.microsoft.com/en-us/store/badges/images/English_get-it-from-MS.png" alt="Download now" width="284"/></a>

### WinGet
### Option 2: WinGet

```
Install via command line using Windows Package Manager:

```bash
winget install 9NJMTKK6JC0Q --source msstore
```

or
```

```bash
winget install WinQuickLook --source msstore
```

## Usage
## 🚀 Quick Start

1. **Install & Launch** - Download WinQuickLook and launch the application
2. **Browse Files** - Open any folder in Windows File Explorer
3. **Select a File** - Click on any file you want to preview
4. **Press <kbd>Space</kbd>** - Instantly preview the file content
5. **Press <kbd>Esc</kbd>** - Close the preview and continue browsing

That's it! WinQuickLook will run in the background, ready whenever you need it.

## 💡 Use Cases

1. Launch `WinQuickLook`
2. Open folder in explorer
3. Select a file
4. Press a <kbd>space</kbd> key
- **Quick Document Review** - Scan through multiple documents without opening Word, PDF readers, etc.
- **Image Browsing** - Preview photos instantly while organizing your photo library
- **Code Review** - Quickly check source code files without launching your IDE
- **Media Preview** - Check video or audio content before opening in a full media player
- **File Management** - Verify file contents while cleaning up folders

## Supported OS versions
## 🖥️ System Requirements

- Windows 10 Version 1903 or later
- Windows 11

## License
## 🤝 Contributing

We welcome contributions! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making WinQuickLook better.

- **Report Issues** - [GitHub Issues](https://github.com/polymind-inc/WinQuickLook/issues)
- **Feature Requests** - Share your ideas for new features
- **Pull Requests** - Contribute code improvements

## 📄 License

This project is licensed under the [Apache License 2.0](https://github.com/polymind-inc/WinQuickLook/blob/master/LICENSE)

## ⭐ Show Your Support

If you find WinQuickLook useful, please consider:
- ⭐ Starring this repository
- 🐦 Sharing with your friends and colleagues
- 💬 Leaving a review on the Microsoft Store