From f075f420fc22ab8b89cb1fb052c7aa6556b1bd7b Mon Sep 17 00:00:00 2001 From: Paddy Xu Date: Sun, 18 Jun 2017 17:36:10 +0300 Subject: [PATCH] Update README.md --- README.md | 51 +++++++-------------------------------------------- 1 file changed, 7 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 0a9d15f..edf2701 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,9 @@ You may ask, why you write this when there several alternatives available on the ✅ Native 64-bit application ✅ Preview from Open and Save File Dialog +✅ Preview from 3rd-party file managers ✅ Easy extended by plugins + ✅ Strict GPL license to keep it free forever ## Usage @@ -46,58 +48,19 @@ You may ask, why you write this when there several alternatives available on the - Mouse️ ↑ ↓ ← → Preview another file - Ctrl-Wheel Zoom in/out images -### Integration - - You may set up a custom hot key that fires event `QuickLook.exe C:\path\to\your\file.txt`. - - For developer: Send **a line** (ends with `\r\n`) of UTF-8 string which contains the file path to the [named pipe](https://msdn.microsoft.com/en-us/library/windows/desktop/aa365590(v=vs.85).aspx) named `\\.\pipe\QuickLook.App.Pipe`. - +## More Information -## Features -Till now, QuickLook supports the preview of +See the [Wiki page](https://github.com/xupefei/QuickLook/wiki). - - Images: e.g. `.png`, `.jpg`, `.bmp`, `.gif`, `.psd` and Camera RAW formats - - Compressed archives: `.zip`, `.rar`, `.tar.gz`, `.7z` etc. - - Pdf file - - All kinds of text files (determined by file content) - - Microsoft Word (`.doc`, `.docx`), Excel (`.xls`, `.xlsx`) and PowerPoint (`.ppt`, `.pptx`) files (requires MS Office installation) - - OpenDocument (`odt`, `.ods` and `.odp`) files (requires MS Office installation) - - Video files (`.mp4`, `.mkv`, `.m2ts` etc.) - - HTML files (`.htm`, `.html`) - - Markdown file (`.md`) - - Other files and folders will be shown in a information box - -## Development - -The previewing ability can be extended by new plugins. Read the [plugin interface](https://github.com/xupefei/QuickLook/blob/master/QuickLook/Plugin/IViewer.cs), [context object](https://github.com/xupefei/QuickLook/blob/master/QuickLook/Plugin/ContextObject.cs) for more information. [Out-of-box plugins](https://github.com/xupefei/QuickLook/tree/master/QuickLook.Plugin) contain more detailed implementation. -Note that any plugin must be under the `QuickLook.Plugin` namespace, has the filename similar to `QuickLook.Plugin.YourPlugin.dll` and placed under `\Plugins\QuickLook.Plugin.YourPlugin\` subfolder. - -## Related projects - -QuickLook is standing on shoulders of several open-source libraries, named - - - [AvalonEdit](https://github.com/icsharpcode/AvalonEdit): the WPF-based text editor component used in SharpDevelop - - [dcraw](http://www.cybercom.net/~dcoffin/dcraw/): decoding raw digital photos in Linux - - [ExifLib](https://www.codeproject.com/Articles/36342/ExifLib-A-Fast-Exif-Data-Extractor-for-NET): a fast Exif data extractor for .NET 2.0+ - - [FFmpeg](https://ffmpeg.org/): a complete, cross-platform solution to record, convert and stream audio and video - - [FFmpegMediaElement](https://github.com/unosquare/ffmediaelement/tree/master/Unosquare.FFmpegMediaElement): WPF MediaElement replacement based on FFmpeg - - [Font-Awesome-WPF](https://github.com/charri/Font-Awesome-WPF): WPF & UWP controls for the iconic font and CSS toolkit Font Awesome - - [github-markdown-css](https://github.com/sindresorhus/github-markdown-css): The minimal amount of CSS to replicate the GitHub Markdown style - - [ImageMagick](http://www.imagemagick.org): convert, edit, or compose bitmap images - - [Magick.NET](https://github.com/dlemstra/Magick.NET): The .NET wrapper for the ImageMagick library - - [markdown-it](https://github.com/markdown-it/markdown-it): markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed - - [MuPdf](https://mupdf.com/): lightweight PDF, XPS, and E-book viewer - - [PreviewHandlerHost](http://www.brad-smith.info/blog/archives/79): IPreviewHandler Revisited - - [SharpCompress](https://github.com/adamhathcock/sharpcompress): a fully managed C# library to deal with many compression types and formats - - [Sumatra PDF](https://www.sumatrapdfreader.org): a PDF, ePub, MOBI, CHM, XPS, DjVu, CBZ, CBR reader for Windows - - [WpfWebBrowserWrapper](https://www.codeproject.com/Articles/555302/A-better-WPF-Browser-Control-IE-Wrapper): a better WPF-Browser-Control (IE-Wrapper) - - [XamlAnimatedGif](https://github.com/XamlAnimatedGif/XamlAnimatedGif): a simple library to display animated GIF images in XAML apps - ## Licenses ![GPL-v3](https://www.gnu.org/graphics/gplv3-127x51.png) Application icons made by Freepik from www.flaticon.com. Used under the [Flaticon Basic License](http://file000.flaticon.com/downloads/license/license.pdf). -All source codes, except which are from other projects mentioned in “Related projects” section, are licensed under [GPL-3.0](https://opensource.org/licenses/GPL-3.0). +This project references many other projects. See [here](https://github.com/xupefei/QuickLook/wiki/Related-Projects) 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.