summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDan Nicholson <dbn.lists@gmail.com>2012-08-18 08:26:59 -0700
committerDan Nicholson <dbn.lists@gmail.com>2012-08-18 08:43:34 -0700
commit8d3d670baf6bafc010ba18173d544179d034eb4a (patch)
tree742e9dc88307c99e1324a94521fb21acce630e0e /README
parent5876e7656cecc8378d275f90514e33c104dcece7 (diff)
Add and distribute README and AUTHORS
Add README and AUTHORS files describing the project a bit more. Distribute them by removing the foreign option from automake. This also distributes the INSTALL file, but automake will give us a stock one if none is in the directory.
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..920205d
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+evince-browser-plugin provides a document viewer plugin for browsers
+that support the NPAPI plugin system like those based on Mozilla (like
+Firefox) and WebKit (like Epiphany). Currently the plugin depends on
+using a GTK+ context from the XEmbed mechanism. That basically means it
+can be used on GTK+ systems using X11.
+
+The plugin uses the Evince libraries, so any document formats it
+supports can be viewed through the plugin. The two most common document
+formats are PDF and Postscript, allowing it to be used like the Adobe
+Reader product.
+
+One important note is that as of Firefox version 14, only GTK+ version 2
+plugins are supported. This means that evince-browser-plugin must use
+Evince version 2 libraries if it's intended to be used with Firefox. On
+the other hand, the current Epiphany browser on GNOME 3 only supports
+GTK+ version 3 plugins. evince-browser-plugin allows you to build it as
+a gtk2/evince2 plugin and/or a gtk3/evince3 plugin. See the help text
+from configure for details about controlling this.
+
+When GTK+ version 3 support comes to Mozilla/Firefox, it will become the
+default usage. There are two bugs tracking the support of gtk3 in
+Mozilla's backend:
+
+https://bugzilla.mozilla.org/show_bug.cgi?id=627699
+https://bugzilla.mozilla.org/show_bug.cgi?id=624422
+
+When encountering bugs with the plugin, you can contact me at
+<dbn.lists@gmail.com>. Likewise, I also announce releases and monitor
+the messages on the evince mailing list. You can find out more
+information about that list and read the archives at:
+
+https://mail.gnome.org/mailman/listinfo/evince-list