Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Put commands in separate code sections

I also turned all the plugin names bold to stand out a bit better.
  • Loading branch information...
commit c9da86eb629683876c7817bb764841b07304353f 1 parent a83ff00
@chrisridd authored
Showing with 21 additions and 7 deletions.
  1. +21 −7 README.markdown
View
28 README.markdown
@@ -1,8 +1,8 @@
# An EPUB QuickLook generator and Spotlight importer for Mac OS X
-The epub.qlgenerator plugin is designed to extract the cover images from EPUB files to use as the file icon, and present a nice overview of the EPUB in QuickLook.
+The **epub.qlgenerator** plugin is designed to extract the cover images from EPUB files to use as the file icon, and present a nice overview of the EPUB in QuickLook.
-The epub.mdimporter plugin is designed to extract information from EPUB files (metadata as well as text content) and index it so that Spotlight can search it.
+The **epub.mdimporter** plugin is designed to extract information from EPUB files (metadata as well as text content) and index it so that Spotlight can search it.
These plugins read the various information directly from the EPUB contents - so will work on books that haven't been imported into iTunes.
@@ -10,14 +10,28 @@ These plugins read the various information directly from the EPUB contents - so
## Installation
-Place the epub.qlgenerator file into `/Library/QuickLook` (for all users) or `~/Library/QuickLook` (for the current user only).
+Place the **epub.qlgenerator** file into `/Library/QuickLook` (for all users) or `~/Library/QuickLook` (for the current user only).
-The Mac should notice the plugin appearing and start using it automatically. If it doesn't seem to, try logging out and in again, or run Terminal.app and enter this command: `qlmanage -r` and press return.
+The Mac should notice the plugin appearing and start using it automatically. If it doesn't seem to, try logging out and in again, or run Terminal.app and enter this command:
-Place the epub.mdimporter file into `/Library/Spotlight` (for all users) or `~/Library/Spotlight` (for the current user only).
+ qlmanage -r
-To use the new Spotlight plugin you have to first make it index your EPUB files. Run Terminal.app and enter this command: `mdimport -r /Library/Spotlight/epub.mdimporter` (or `mdimport -r ~/Library/Spotlight/epub.mdimporter` if you installed it for the current user only) and press return. Spotlight will begin indexing your EPUB files in the background.
+and press return.
+
+Place the **epub.mdimporter** file into `/Library/Spotlight` (for all users) or `~/Library/Spotlight` (for the current user only).
+
+To use the new Spotlight plugin you have to first make it index your EPUB files. This can be tricky. One way is to run Terminal.app and enter this command:
+
+ mdimport -r /Library/Spotlight/epub.mdimporter
+
+or:
+
+ mdimport -r ~/Library/Spotlight/epub.mdimporter
+
+if you installed it for the current user only) and press return. There are other ways to run mdimport which might also help - see its man page for more details.
+
+Spotlight will begin indexing your EPUB files in the background.
### Conflict with other QuickLook generators
-Under some circumstances, epub.qlgenerator can conflict with other quicklook generators (notably BetterZipQL under OS X 10.6 and earlier). To fix this, rename epub.qlgenerator to come before the conflicting plugin alphabetically (AA_epub.qlgenerator should work).
+Under some circumstances, **epub.qlgenerator** can conflict with other QuickLook generators (notably BetterZipQL under OS X 10.6 and earlier). To fix this, rename **epub.qlgenerator** to come before the conflicting plugin alphabetically (for example **AA_epub.qlgenerator** should work).
Please sign in to comment.
Something went wrong with that request. Please try again.