Files
QuickLook/README.md
2017-11-15 22:48:27 +02:00

74 lines
4.2 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

![QuickLook icon](https://user-images.githubusercontent.com/1687847/29485863-8cd61b7c-84e2-11e7-97d5-eacc2ba10d28.png)
# QuickLook
[![license](https://img.shields.io/github/license/xupefei/QuickLook.svg)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
[![AppVeyor](https://img.shields.io/appveyor/ci/xupefei/QuickLook.svg)](https://ci.appveyor.com/project/xupefei/QuickLook)
[![Github All Releases](https://img.shields.io/github/downloads/xupefei/QuickLook/total.svg)](https://github.com/xupefei/QuickLook/releases)
[![GitHub release](https://img.shields.io/github/release/xupefei/QuickLook.svg)](https://github.com/xupefei/QuickLook/releases/latest)
<a href="https://www.microsoft.com/store/apps/9nv4bs3l1h4s?ocid=badge" target="_blank"><img src="https://assets.windowsphone.com/f2f77ec7-9ba9-4850-9ebe-77e366d08adc/English_Get_it_Win_10_InvariantCulture_Default.png" height="80px" alt="Get it on Windows 10" /></a>
*This project is currently under heavy development. Come back often to see what's new.*
<img src="http://pooi.moe/QuickLook/sample.gif?3" width="400">
## Background
One of the few features I missed from Mac OS X is [Quick Look](https://en.wikipedia.org/wiki/Quick_Look). It allows user peek into a file content in a lightening speed by just pressing the <kbd>Space</kbd> key. Windows, on the other hand, does not has this handy feature ... until now.
I am aware that several alternatives are already available on the Internet (e.g. [WinQuickLook](https://github.com/shibayan/WinQuickLook) and [Seer](https://github.com/ccseer/Seer)). Despite these options, I still decide to craft another one by myself, because they are either not being actively developed, lacks of variety, or asks for a amount of $$$.
## Highlights
- Tons of supported file types (full list [here](https://github.com/xupefei/QuickLook/wiki/Supported-File-Types))
- Fluent design (new in version 0.3)
- Touchscreen friendly
- HiDPI support
- Preview from Open and Save File Dialog
- Preview from 3rd-party file managers (see a list [here](https://github.com/xupefei/QuickLook/wiki/File-Managers))
- Easy extended by plugins
- Strict GPL license to keep it free forever
## Usage
### Download / General usage
1. Download from one of the following
* Windows Store (for Windows 10 users) <a href="https://www.microsoft.com/store/apps/9nv4bs3l1h4s?ocid=badge" target="_blank"><img src="https://assets.windowsphone.com/13484911-a6ab-4170-8b7e-795c1e8b4165/English_get_L_InvariantCulture_Default.png" width="80px" alt="Store Link" /></a>
* Installer or portable archive of the stable version from [GitHub Release](https://github.com/xupefei/QuickLook/releases)
* Unstable builds from [AppVeyor](https://ci.appveyor.com/project/xupefei/quicklook/build/artifacts)
2. Run `QuickLook.exe`
3. Select a file/folder on the Desktop / in a File Explorer window / in an Open- or Save-File dialog
4. Press <kbd>Spacebar</kbd>
5. Select another file/folder in the same manner
6. When you're done, click on the `❎` button, or press <kbd>Spacebar</kbd> again
### Hotkeys and buttons
- <kbd>Spacebar</kbd> Show/Hide the preview window
- <kbd>Esc</kbd> Hide the preview window
- <kbd>Enter</kbd> Open/Execute current file
- <kbd>Mouse</kbd> <kbd></kbd> <kbd></kbd> <kbd></kbd> <kbd></kbd> Preview another file
- <kbd>Ctrl-Wheel</kbd> Zoom in/out images
- <kbd>Wheel</kbd> Increase/decrease volume
## More Information
See the [Wiki page](https://github.com/xupefei/QuickLook/wiki).
## Translations
See the [Wiki page](https://github.com/xupefei/QuickLook/wiki/Translations).
## Licenses
![GPL-v3](https://www.gnu.org/graphics/gplv3-127x51.png)
Application icons made by [@QubitsDev](https://twitter.com/qubitsdev). User interface designed by [@OiCkilL](https://twitter.com/OiCkilL). Thank you!
This project references many other projects. See [here](https://github.com/xupefei/QuickLook/wiki/On-the-Shoulders-of-Giants) for the full list.
All source codes, except which are from other projects mentioned above, are licensed under [GPL-3.0](https://opensource.org/licenses/GPL-3.0).
If you want make any modification on these source codes while keeping new codes not protected by GPL-3.0, please contact me for a sublicense instead.