Skip to content

Commit 8ceb73e

Browse files
authored
Create README.md
1 parent 328b6c2 commit 8ceb73e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
![QuickLook icon](https://user-images.githubusercontent.com/1687847/29485863-8cd61b7c-84e2-11e7-97d5-eacc2ba10d28.png)
2+
3+
# QuickLook.Plugin.HelloWorld
4+
5+
This plugin illustrates the development process of [QuickLook](https://github.com/QL-Win/QuickLook).
6+
7+
## Try out
8+
9+
1. Go to [Release page](https://github.com/QL-Win/QuickLook.Plugin.HelloWorld/releases) and download the latest version.
10+
2. Make sure that you have QuickLook running in the background. Go to your Download folder, and press <key>Spacebar</key> on the downloaded `.qlplugin` file.
11+
3. Click the “Install” button in the popup window.
12+
4. Restart QuickLook.
13+
5. Create a file, change its extension to `.zzz`.
14+
6. Select the file and press <key>Spacebar</key>.
15+
16+
## Development
17+
18+
1. Clone this project. Do not forget to update submodules.
19+
2. Build project with `Release` profile.
20+
3. Run `Scripts\pack-zip.ps1`.
21+
4. You should find a file named `QuickLook.Plugin.HelloWorld.qlplugin` in the project directory.
22+
23+
## License
24+
25+
MIT License.

0 commit comments

Comments
 (0)