diff --git a/README.md b/README.md index b1d5df4a2..49c64b3a1 100644 --- a/README.md +++ b/README.md @@ -1,120 +1,899 @@ - + + + + + QuickLook Logo + # QuickLook - +
+ +

+ + Instant File Previews, Just Press Space + +

+ +**The most powerful Quick Look implementation for Windows** + + + Trending + + +
+ + +

+ + Release + + + Downloads + + + Stars + + + License + + + Build Status + + + Platform + +

+ + +

+ + +QuickLook Preview + +

+ + + + + + + + + + +
+ +
+ The Problem +
+
+ +
+ Superpowers +
+
+ +
+ Get Started +
+
+ +
+ Extend +
+
+ +
+ Community +
+
+ +
+ +
+ +--- + +## ๐Ÿ’ก The Problem + + + + + + +
+ +### Ever wished Windows had macOS's Quick Look? + +You know the drill: you want to peek at a file, so you double-click, wait for an app to launch, view the file, close the app... **exhausting**, right? + +macOS users? They just press Space. Instant preview. **Any file**. + +**Now Windows has it too.** ๐ŸŽ‰ + +QuickLook brings that buttery-smooth, instant-preview experience to Windows. No more waiting. No more opening heavy applications just to peek at a document. + + + +``` +WITHOUT QuickLook: +โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” +โ”‚ 1. Double click โ”‚ +โ”‚ 2. Wait... โ”‚ +โ”‚ 3. App loads โ”‚ +โ”‚ 4. View file โ”‚ +โ”‚ 5. Close app โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + โฑ๏ธ ~10 seconds + +WITH QuickLook: +โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” +โ”‚ 1. Press SPACE โ”‚ +โ”‚ 2. Done! โœจ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + โšก ~0.2 seconds +``` + +
+ +
+ +--- + +## ๐Ÿš€ Superpowers + +
+ +### What Makes QuickLook Extraordinary + +
+ + + + + + + +
+ +### โšก๏ธ **Lightning Speed** + + + +**Instant previews** with zero lag + +Native performance that feels like magic + +Hardware-accelerated rendering + + + +### ๐ŸŽจ **Gorgeous Design** + + + +**Fluent Design System** integration + +Beautiful on 4K displays + +Touch-optimized interface + + + +### ๐ŸŒˆ **100+ Formats** + + + +Images, videos, documents, code + +**3D models**, archives, fonts + +Extensible with plugins + +
+ +
+ + + + + + + +
+ +#### ๐Ÿ“ธ **Visual Files** +- ๐Ÿ–ผ๏ธ Images (JPEG, PNG, GIF, WebP, RAW) +- ๐ŸŽฌ Videos (MP4, AVI, MKV, MOV) +- ๐ŸŽจ Photoshop (PSD), Illustrator (AI) +- ๐Ÿ“ 3D Models (OBJ, STL, FBX) +- ๐ŸŽญ Animated GIFs & APNGs + +#### ๐Ÿ“„ **Documents** +- ๐Ÿ“ PDF, Word, Excel, PowerPoint +- ๐Ÿ“‹ Text files with syntax highlighting +- ๐Ÿ“Š Markdown with live rendering +- ๐Ÿ“œ E-books (EPUB, MOBI) +- ๐Ÿ“‘ Comics (CBZ, CBR) + + + +#### ๐Ÿ’ป **Developer Files** +- ๐Ÿ Python, JavaScript, C++, Rust +- ๐ŸŒ HTML, CSS, JSON, XML +- โš™๏ธ Config files (YAML, TOML, INI) +- ๐Ÿ“ฆ Archives (ZIP, RAR, 7Z, TAR) +- ๐Ÿ”ง Binary files with hex view + +#### ๐ŸŽต **Media** +- ๐ŸŽต Audio (MP3, FLAC, WAV, AAC) +- ๐ŸŽผ Sheet music +- ๐ŸŽจ Fonts (TTF, OTF, WOFF) +- ๐Ÿ–Œ๏ธ Vector graphics (SVG, EPS) +- ๐Ÿ“น Subtitles (SRT, ASS) + +
+ +
+ +
+ +### ๐ŸŽฏ **Works Everywhere** + + + + + + + + +
+ +**File Explorer** + + + +Native integration + + + +**Open/Save Dialogs** + + + +System-wide support + + + +**3rd Party Managers** + + + +Total Commander, xplorerยฒ + + + +**Cloud Storage** + + + +OneDrive, Dropbox ready + +
+ +
+ +
+ +--- + +## ๐Ÿ“ฆ Get Started + +
+ +### Choose Your Adventure + +
+ + + + + + + + +
+ + + +### **Microsoft Store** + +**Recommended for most users** + +โœ… Automatic updates +โœ… Sandboxed security +โœ… One-click install + +
+ + + Microsoft Store + + +โš ๏ธ Limited Open/Save dialog support + +
+ + + +### **Installer** + +**Full-featured experience** + +โœ… Complete functionality +โœ… Open/Save dialog support +โœ… Portable option available + +
+ + + Latest Release + + +๐Ÿ’Ž Get the full power + +
+ + + +### **Scoop** + +**For command-line lovers** + +โœ… Easy updates +โœ… Reproducible installs +โœ… Version management + +
+ +```powershell +scoop bucket add extras +scoop install quicklook +``` + +๐Ÿค“ Power user choice + +
+ + + +### **Nightly** + +**Live on the edge** + +โœ… Latest features +โœ… Bug fixes first +โš ๏ธ May be unstable + +
+ + + Nightly Builds + + +๐ŸŒ™ Experimental builds + +
+ +
+ +
+๐Ÿค” Not sure which version to choose? + +
+ +| Feature | Store | Installer | Scoop | Nightly | +|---------|-------|-----------|-------|---------| +| Auto-updates | โœ… | โš ๏ธ | โœ… | โš ๏ธ | +| Open/Save dialogs | โŒ | โœ… | โœ… | โœ… | +| Portable mode | โŒ | โœ… | โŒ | โœ… | +| Stability | โœ…โœ…โœ… | โœ…โœ…โœ… | โœ…โœ…โœ… | โœ…โœ… | + +๐Ÿ“– [Read the full comparison](https://github.com/QL-Win/QuickLook/wiki/Differences-Between-Distributions) + +
+ +
+ +
+ +### โšก Quick Start in 10 Seconds + + + + + + +
+ +``` +Step 1๏ธโƒฃ Install QuickLook + โ†“ +Step 2๏ธโƒฃ It runs automatically + โ†“ +Step 3๏ธโƒฃ Select any file + โ†“ +Step 4๏ธโƒฃ Press SPACE + โ†“ +Step 5๏ธโƒฃ ๐ŸŽ‰ Magic happens! +``` + + + +**๐Ÿ’ก Pro Tips:** +- QuickLook lives in your system tray +- Works with **any file** in File Explorer +- Use arrow keys to preview multiple files +- Press `Esc` or `Space` again to close +- Drag files directly from the preview! + +
+ +
+ +--- + +## โŒจ๏ธ Master the Shortcuts + +
+ +### Your New Superpowers + +
+ + + + + + + +
+ +### ๐ŸŽฎ **Basic Controls** + +| Key | Action | +|-----|--------| +| Space | Toggle preview | +| Esc Space | Close window | +| Enter | Open file | +| โ†‘ โ†“ | Next/Previous | + + + +### ๐Ÿ” **Navigation** + +| Key | Action | +|-----|--------| +| โ† โ†’ | Navigate files | +| Mouse Click | Select file | +| Page Up Down | Scroll content | +| Home End | Jump to start/end | + + + +### ๐ŸŽจ **Advanced** + +| Key | Action | +|-----|--------| +| Wheel | Zoom (images) | +| Ctrl+Wheel | Zoom (PDFs) | +| L-Click Drag | Rotate 3D | +| M-Click Drag | Pan 3D | + +
+ +
+ +> **๐Ÿ’ก Pro Tip:** You can navigate files using arrow keys even when the preview window isn't focused! + +
+ +
+ +--- + +## ๐Ÿงฉ Extend + +
+ +### Supercharge QuickLook with Plugins + +*Transform QuickLook into a universal file viewer* + +
+ + + + + + + + + + + +
+ + + +### **OfficeViewer** + +Preview **Word, Excel & PowerPoint** files + +**No Microsoft Office required!** + +
+ +``` +โœ… Native Office formats +โœ… Standalone viewer +โœ… Fast rendering +``` + + + Download + + +
+ + + +### **PdfViewer-Native** + +Enhanced PDF viewing with **WebView2** + +Modern, fast, feature-rich + +
+ +``` +โœ… Smooth scrolling +โœ… Search & annotations +โœ… Hardware acceleration +``` + + + Download + + +
+ + + +### **PostScriptViewer** + +Preview `.ps` and `.eps` files + +Perfect for designers + +
+ +``` +โœ… Vector rendering +โœ… High quality output +โœ… Professional formats +``` + + + Download + + +
+ + + +### **CADImport** + +View CAD files natively + +`.dwg`, `.dxf`, `.plt`, `.cgm` + +
+ +``` +โœ… Engineering drawings +โœ… Architecture files +โœ… Technical diagrams +``` + + + Download + + +
+ +
+ +### ๐Ÿ“ฆ How to Install or Upgrade Plugins + + + + + + + +
+ +**1๏ธโƒฃ Download** + +Get the `.qlplugin` file + + + +**2๏ธโƒฃ Install** + +Ensure QuickLook is currently running, select the file and press `Spacebar`. + + + +**3๏ธโƒฃ Restart** + +Click on the `Install` button, then restart QuickLook. + +
+ +### ๐Ÿ“ฆ How to Remove Plugins + + + + + + + +
+ +**1๏ธโƒฃ Quit** + +Quit QuickLook. + + + +**2๏ธโƒฃ Navigate** + +Navigate to the [Data location](https://github.com/QL-Win/QuickLook/wiki/Differences-Between-Distributions#user-data-location). + + + +**3๏ธโƒฃ Remove** + +You should find several folders. Remove the one you do not want to use. + +
+ +
+ + + Browse Plugins + + + Installation Guide + + +
+ +
+ +--- + +## ๐Ÿ’– Community + +
+ +### Join Thousands of Happy Users + +
+ + + + + + + +
+ + + +### **QQ Group** + +Join our Chinese community + +**371388501** + +
+ + + QQ Group + + +
+ + + +### **Translate** + +Help QuickLook speak your language + +Make it accessible + +
+ + + Translations + + +
+ + + +### **Star Us** + +Show your support + +It means a lot! + +
+ + + Star us + + +
+ +
+ +### ๐Ÿ‘จโ€๐Ÿ’ป For Developers + +Interested in contributing? Check out our development resources: + + + Wiki + + + Code Style + + + Issues + + +
+ +
+ +--- + +## ๐Ÿ™ Credits + +
+ +### Built with Love by Amazing People + +
+ + + + + + + + +
+ + + +**Design Team** + +[@OiCkilL](https://twitter.com/OiCkilL) +[@QubitsDev](https://twitter.com/qubitsdev) +[Donno](https://github.com/Donnnno) + +*Fluent UI & Icons* + + + + + +**Contributors** -[![license](https://img.shields.io/github/license/QL-Win/QuickLook.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) -[![Actions](https://github.com/QL-Win/QuickLook/actions/workflows/msbuild.yml/badge.svg)](https://github.com/QL-Win/QuickLook/actions/workflows/msbuild.yml) -[![Platform](https://img.shields.io/badge/platform-Windows-blue?logo=windowsxp&color=1E9BFA)](https://dotnet.microsoft.com/en-us/download/dotnet/latest/runtime) -[![Github All Releases](https://img.shields.io/github/downloads/QL-Win/QuickLook/total.svg)](https://github.com/QL-Win/QuickLook/releases) -[![GitHub release](https://img.shields.io/github/release/QL-Win/QuickLook.svg)](https://github.com/QL-Win/QuickLook/releases/latest) +[Our Amazing Team](https://github.com/QL-Win/QuickLook/graphs/contributors) - +*Code, translations & ideas* -## Background -One of the few features I missed from macOS is [Quick Look](https://en.wikipedia.org/wiki/Quick_Look). It allows users to peek into a file content in lightning speed by just pressing the Space key. Windows, on the other hand, does not have this handy feature ... until now! + -I am aware that several alternatives are already available on the Internet but I still decided to craft another one by myself, because they are either not being actively developed, lack of variety. + -## Highlights +**Open Source** - - Tons of supported file types (full list [here](https://github.com/QL-Win/QuickLook/wiki/Supported-File-Types)) - - Fluent design - - Touchscreen friendly - - HiDPI support - - Preview from *Open* and *Save File* Dialog - - Preview from 3rd-party file managers (see a list [here](https://github.com/QL-Win/QuickLook/wiki/File-Managers)) - - Easily extended by [plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins) - - Strict GPL license to keep it free forever +[Libraries We Use](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) -## Usage +*Standing on giants* -### Download/Installation + -Get it from one of the following sources: + - * Microsoft Store (Windows 10 and later only). Not supported on Windows 10 S. Not support file preview in Open-File or Save-File dialogs. Store Link - * Installer or portable archive of the stable version from [GitHub Release](https://github.com/QL-Win/QuickLook/releases) - * Using [Scoop](https://scoop.sh/): `scoop bucket add extras && scoop install extras/quicklook` - * Nightly builds from [GitHub Action](https://github.com/QL-Win/QuickLook/releases/) +**You!** -[What are the differences between `.msi`, `.zip`, Nightly and Store versions?](https://github.com/QL-Win/QuickLook/wiki/Differences-Between-Distributions) +Every User Matters -**Note:** Don't forget to check out the [plugins](https://github.com/QL-Win/QuickLook?tab=readme-ov-file#plugins) for previewing office-files, epubs, fonts and more! +*Thank you for using QuickLook* +
-### Typical usecase +
-1. Run `QuickLook.exe` (only necessary if autostart is disabled) -1. Select any file or folder (on the Desktop, in a File Explorer window, in an *Open* or *Save-File* dialogue, doesn't matter) -1. Press Spacebar -1. Enjoy the preview and interact with it -1. Preview next file by clicking on it or using arrow-keys (arrow-keys move selection in the background if the preview window is not in focus) -1. When you're done close it by either hitting Spacebar again, pressing Esc or clicking the `โจ‰` button +
-### Hotkeys and buttons +--- - - Spacebar Show/Hide the preview window - - Esc Hide the preview window - - Enter Open/Execute current file - - Mouse โ†‘ โ†“ โ† โ†’ Preview another file - - Mouse Wheel Zoom in/out (images) - - Ctrl+Mouse Wheel Zoom in/out (PDFs) - - Wheel Increase/decrease volume - - Left Mouse Rotate (3D models) - - Middle Mouse Pan (3D models) +## ๐Ÿ“œ License -## Plugins +
-### Official Plugins +
-| Name | Description | URL | -| ------------------------------------------------------------ | ---------------------------------------------------------- | ------------------------------------------------------------ | -| [OfficeViewer](https://github.com/QL-Win/QuickLook.Plugin.OfficeViewer) | View Office formats **without installing MS Office**. | [Link](https://github.com/QL-Win/QuickLook.Plugin.OfficeViewer/releases) | -| [PdfViewer-Native](https://github.com/QL-Win/QuickLook.Plugin.PdfViewer-Native) | View the PDF files with WebView2. | [Link](https://github.com/QL-Win/QuickLook.Plugin.PdfViewer-Native/releases) | -| [PostScriptViewer](https://github.com/QL-Win/QuickLook.Plugin.PostScriptViewer) | Preview PostScript `.ps` and `.eps` files. | [Link](https://github.com/QL-Win/QuickLook.Plugin.PostScriptViewer/releases) | -| [CADImport](https://github.com/emako/QuickLook.Plugin.CADImport) | Preview CAD file formats (`.dwg`, `.dxf`, `.plt`, `.cgm`). | [Link](https://github.com/emako/QuickLook.Plugin.CADImport/releases) | +GPL v3 -Here is the complete list of plugins from [Available-Plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins). +

-See [here](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins#how-to-install-or-upgrade-a-plugin) for instructions on how to install plugins. +**QuickLook is free and open source under [GPL-3.0](https://opensource.org/licenses/GPL-3.0)** -## Supported file formats +*Free software, free forever. No ads, no tracking, no premium tiers.* -See the [Supported formats](SUPPORTED_FORMATS.md) +
-## Supported file manager integration, etc. +**Need commercial licensing?** Contact us for sublicensing options. -See the [Wiki page](https://github.com/QL-Win/QuickLook/wiki) +
-## Translations +
-See the [Translation guide](https://github.com/QL-Win/QuickLook/wiki/Translations) +--- -## Community +
-QQ Group: [371388501](https://qm.qq.com/q/KIczirznua) +
-## Developer +## โญ Like QuickLook? Star the repo! -- **Formatter**: [CodeMaid.config](CodeMaid.config), [Settings.XamlStyler](Settings.XamlStyler) +**Your support keeps this project alive and improving** -## Thanks to +
- - Many [open-source projects](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) and their contributors - - Our UI designers [@OiCkilL](https://twitter.com/OiCkilL) (โ€œFluentโ€ user interface since v0.3), [@QubitsDev](https://twitter.com/qubitsdev) (app-icon v0.3-v3.6.9) and [Donno](https://github.com/Donnnno) (app-icon since v3.6.10) - - [Our contributers](https://github.com/QL-Win/QuickLook/graphs/contributors) who - - teach QuickLook to speak *your* language - - send pull requests, report bugs or give suggestions - - ... and you ๐Ÿ˜Š + + Homepage + + + Docs + + + Help + + + Download + -## Licenses +

-![GPL-v3](https://www.gnu.org/graphics/gplv3-127x51.png) +Made with โค๏ธ by the QuickLook community -This project references many other open-source projects. See [here](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) for the full list. +
-All source codes are licensed under [GPL-3.0](https://opensource.org/licenses/GPL-3.0). + + + + + -If you want to make any modification on these source codes while keeping new codes not protected by GPL-3.0, please contact me for a sublicense instead. +
\ No newline at end of file