Merge branch 'feature/upstream' into develop

1 files changed, 27 insertions, 0 deletions

diff --git a/samples/simple-plugin/README b/samples/simple-plugin/README
new file mode 100644
index 0000000..090389e
--- /dev/null
+++ b/samples/simple-plugin/README
@@ -0,0 +1,27 @@
+
+    simple-plugin
+    -------------
+    
+    This sample plugin implements the barebones for a SPIT module that can be
+    loaded by Shotwell at startupp.  However, because it implements no
+    Spit.Pluggables, is does not actually extend Shotwell's functionality.
+    
+    Note that the Shotwell plugin developer headers must be installed prior
+    to building simple-plugin.  This can be done from the source code like so:
+    
+    $ ./configure --install-headers
+    $ make
+    $ make install
+    
+    You probably need to be root prior to running "make install" ("sudo make
+    install" or some variant).
+    
+    NOTE: simple-plugin's Makefile is *not* designed to install the plugin in
+    a system directory.  Rather, it installs the plugin in the user's plugin
+    directory (in ~/.gnome2/shotwell/plugins).  To build and install 
+    simple-plugin:
+    
+    $ make
+    $ make install
+    
+    Copyright 2016 Software Freedom Conservancy Inc.