Skip to content

Commit 1ad4e24

Browse files
authored
Merge pull request #350 from rabelux/UpdateREADME
Updated readme
2 parents 3ff0dcc + d928d88 commit 1ad4e24

File tree

1 file changed

+35
-29
lines changed

1 file changed

+35
-29
lines changed

README.md

+35-29
Original file line numberDiff line numberDiff line change
@@ -3,79 +3,85 @@
33

44
# QuickLook
55

6-
[![license](https://img.shields.io/github/license/xupefei/QuickLook.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
6+
[![license](https://img.shields.io/github/license/QL-Win/QuickLook.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
77
[![AppVeyor](https://img.shields.io/appveyor/ci/xupefei/QuickLook.svg)](https://ci.appveyor.com/project/xupefei/QuickLook)
8-
[![Github All Releases](https://img.shields.io/github/downloads/xupefei/QuickLook/total.svg)](https://github.com/xupefei/QuickLook/releases)
9-
[![GitHub release](https://img.shields.io/github/release/xupefei/QuickLook.svg)](https://github.com/xupefei/QuickLook/releases/latest)
8+
[![Github All Releases](https://img.shields.io/github/downloads/QL-Win/QuickLook/total.svg)](https://github.com/QL-Win/QuickLook/releases)
9+
[![GitHub release](https://img.shields.io/github/release/QL-Win/QuickLook.svg)](https://github.com/QL-Win/QuickLook/releases/latest)
1010

1111
*This project is currently under heavy development. Come back often to see what's new.*
1212

1313
<img src="http://pooi.moe/QuickLook/sample.gif?3" width="400">
1414

1515
## Background
16-
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.
16+
One of the few features I missed from macOS is [Quick Look](https://en.wikipedia.org/wiki/Quick_Look). It allows user peek into a file content in lightning speed by just pressing the <kbd>Space</kbd> key. Windows, on the other hand, does not have this handy feature ... until now.
1717

18-
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 $$$.
18+
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 decided to craft another one by myself, because they are either not being actively developed, lack of variety, or ask for an amount of $$$.
1919

2020
## Highlights
2121

22-
- Tons of supported file types (full list [here](https://github.com/xupefei/QuickLook/wiki/Supported-File-Types))
22+
- Tons of supported file types (full list [here](https://github.com/QL-Win/QuickLook/wiki/Supported-File-Types))
2323
- Fluent design (new in version 0.3)
2424
- Touchscreen friendly
2525
- HiDPI support
26-
- Preview from Open and Save File Dialog
27-
- Preview from 3rd-party file managers (see a list [here](https://github.com/xupefei/QuickLook/wiki/File-Managers))
28-
- Easy extended by plugins
26+
- Preview from *Open* and *Save File* Dialog
27+
- Preview from 3rd-party file managers (see a list [here](https://github.com/QL-Win/QuickLook/wiki/File-Managers))
28+
- Easily extended by [plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins)
2929
- Strict GPL license to keep it free forever
3030

3131
## Usage
3232

33-
### Download / General usage
33+
### Download/Installation
3434

35-
[What are the differences between `.msi`, `.zip`, nightly and Store versions?](https://github.com/xupefei/QuickLook/wiki/Difference-between-distributions)
35+
Get it from one of the following sources:
3636

37-
1. Download from one of the following
38-
* Microsoft 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>
39-
* Installer or portable archive of the stable version from [GitHub Release](https://github.com/xupefei/QuickLook/releases)
40-
* Nightly builds from [AppVeyor](https://ci.appveyor.com/project/xupefei/quicklook/build/artifacts)
41-
2. Run `QuickLook.exe`
42-
3. Select a file/folder on the Desktop / in a File Explorer window / in an Open- or Save-File dialog
43-
4. Press <kbd>Spacebar</kbd>
44-
5. Select another file/folder in the same manner
45-
6. When you're done, click on the `` button, or press <kbd>Spacebar</kbd> again
37+
* Microsoft Store (Windows 10 users only) <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" height="22px" alt="Store Link" /></a>
38+
* Installer or portable archive of the stable version from [GitHub Release](https://github.com/QL-Win/QuickLook/releases)
39+
* Nightly builds from [AppVeyor](https://ci.appveyor.com/project/xupefei/quicklook/build/artifacts)
40+
41+
[What are the differences between `.msi`, `.zip`, Nightly and Store versions?](https://github.com/QL-Win/QuickLook/wiki/Difference-Between-Distributions)
42+
43+
44+
### Typical usecase
45+
46+
1. Run `QuickLook.exe` (only necessary if autostart is disabled)
47+
1. Select any file or folder (on the Desktop, in a File Explorer window, in an *Open* or *Save-File* dialogue, doesn't matter)
48+
1. Press <kbd>Spacebar</kbd>
49+
1. Enjoy the preview and interact with it
50+
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)
51+
1. When you're done close it by either hitting <kbd>Spacebar</kbd> again, pressing <kbd>Esc</kbd> or clicking the `` button
4652

4753
### Hotkeys and buttons
4854

4955
- <kbd>Spacebar</kbd> Show/Hide the preview window
5056
- <kbd>Esc</kbd> Hide the preview window
5157
- <kbd>Enter</kbd> Open/Execute current file
5258
- <kbd>Mouse</kbd> <kbd>↑</kbd> <kbd>↓</kbd> <kbd>←</kbd> <kbd>→</kbd> Preview another file
53-
- <kbd>Ctrl-Wheel</kbd> Zoom in/out images
59+
- <kbd>Ctrl</kbd>+<kbd>Wheel</kbd> Zoom in/out (images & pdf)
5460
- <kbd>Wheel</kbd> Increase/decrease volume
5561

5662
## Supported file types, file manager intergation, etc.
5763

58-
See the [Wiki page](https://github.com/xupefei/QuickLook/wiki)
64+
See the [Wiki page](https://github.com/QL-Win/QuickLook/wiki)
5965

6066
## Translations
6167

62-
See the [Translation guide](https://github.com/xupefei/QuickLook/wiki/Translations)
68+
See the [Translation guide](https://github.com/QL-Win/QuickLook/wiki/Translations)
6369

6470
## Thanks to
6571

66-
- Many [open-source projects](https://github.com/xupefei/QuickLook/wiki/On-the-Shoulders-of-Giants) and their contributors
72+
- Many [open-source projects](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) and their contributors
6773
- Our UI designers [@OiCkilL](https://twitter.com/OiCkilL) (“Fluent” user interface since v0.3) and [@QubitsDev](https://twitter.com/qubitsdev) (application icon since v0.3)
68-
- [Our contributers](https://github.com/xupefei/QuickLook/graphs/contributors) who
69-
- teach QuickLook speaks *your* language
70-
- send pull requests, report bugs or give suggestions
74+
- [Our contributers](https://github.com/QL-Win/QuickLook/graphs/contributors) who
75+
- teach QuickLook speaks *your* language
76+
- send pull requests, report bugs or give suggestions
7177
- ... and you 😊
7278

7379
## Licenses
7480

7581
![GPL-v3](https://www.gnu.org/graphics/gplv3-127x51.png)
7682

77-
This project references many other open-source projects. See [here](https://github.com/xupefei/QuickLook/wiki/On-the-Shoulders-of-Giants) for the full list.
83+
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.
7884

7985
All source codes are licensed under [GPL-3.0](https://opensource.org/licenses/GPL-3.0).
8086

81-
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.
87+
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.

0 commit comments

Comments
 (0)