Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added basic description and install how-to.
  • Loading branch information
jakubpetrik committed Oct 8, 2015
1 parent 5b3cc02 commit bbe151a
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# qlplayground
Quick Look support for Swift Playgrounds
QLPlayground
================================
**QLPlayground** is a QuickLook generator for Xcode Playgrounds. Supports both single and multiple paged playgrounds.

Installation
------------

To install, build the `QLPlayground` target and move the `QLPlayground.qlgenerator` into `~/Library/QuickLook/` or into `/Library/QuickLook/`. Later will make it available for all users.
Optionally run `qlmanage -r` to reload QL generators.

Customization
-------------

The generator uses [SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) to highlight the source. You can customize the output by editing files under `.../QLPlayground.qlgenerator/Contents/Resources/`.

0 comments on commit bbe151a

Please sign in to comment.