README
changeset 6 6c753cf22ee8
parent 1 94af07c8f2f3
child 7 44a94a3214b8
--- a/README	Thu Jul 26 10:37:10 2007 -0400
+++ b/README	Thu Jul 26 12:39:29 2007 -0400
@@ -1,53 +1,79 @@
-Snapr - Image gallery in a snap!
-Another fine plugin for Enano CMS
---------------------------------------------------
-
-Welcome and thanks for downloading Snapr, the Enano plugin designed to make
-turning your site into a photo or image gallery a snap.
-
-Copyright
---------------------------------------------------
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; version 2 dated June, 1991.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
-
-Alternatively, you may view a copy of the GNU General Public License in the
-file "COPYING" included with this distribution, or at the following URL:
-
-  <http://enanocms.org/Special:GNU_General_Public_License>
-
-If you already have Enano set up, you can view a copy of the GPL by searching
-for "GNU General Public License".
-
-Installing Snapr
---------------------------------------------------
-
-To install the Snapr plugin on your site, just extract the zip or tarball file
-into your Enano root folder. If you need to upload Snapr manually, upload the
-file plugins/Gallery.php and the entire folder plugins/gallery/ to the
-plugins/ folder inside your Enano root.
-
-To enable Snapr plugin, go to the Administration panel, expand General, click
-Manage Plugins, and click Enable in the row showing the Snapr plugin.
-
-Obtaining support
---------------------------------------------------
-
-Support for Snapr is available via the same support channels as Enano, as it
-is developed and maintained by the official Enano team. For support options,
-both free and commercial, please see <http://enanocms.org/Contact_us>.
-
-Have fun!
-
--- The Enano team
+Snapr - Image gallery in a snap!
+Another fine plugin for Enano CMS
+--------------------------------------------------
+
+Welcome and thanks for downloading Snapr, the Enano plugin designed to make
+turning your site into a photo or image gallery a snap.
+
+Copyright
+--------------------------------------------------
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; version 2 dated June, 1991.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+
+Alternatively, you may view a copy of the GNU General Public License in the
+file "COPYING" included with this distribution, or at the following URL:
+
+  <http://enanocms.org/Special:GNU_General_Public_License>
+
+If you already have Enano set up, you can view a copy of the GPL by searching
+for "GNU General Public License" on your Enano site.
+
+Installing Snapr
+--------------------------------------------------
+
+To install the Snapr plugin on your site, just extract the zip or tarball file
+into your Enano root folder. If you need to upload Snapr manually, upload the
+file plugins/Gallery.php and the entire folder plugins/gallery/ to the
+plugins/ folder inside your Enano root.
+
+To enable Snapr plugin, go to the Administration panel, expand General, click
+Manage Plugins, and click Enable in the row showing the Snapr plugin.
+
+Snapr was developed to be compatible with Enano 1.0, however the copy of Enano
+it was developed under was a 1.0.1 Mercurial pull. If you experience
+compatibility issues with Snapr, they'll probably be fixed with an upgrade to
+the latest copy of Enano in the official Mercurial repository:
+
+  <http://nighthawk.enanocms.org/hg/enano>
+
+Using Snapr
+--------------------------------------------------
+
+The first thing you should do once you get the plugin enabled is go to Edit the
+Sidebar and add a link to Special:Gallery (or Special.Gallery if you use the
+Windows compatibility patch) using normal wikilink syntax. This will enable
+users to access your gallery browser without having to search around. From
+there, you can browse through the gallery (it's empty by default) and create
+folders as needed. Images can be moved in between folders using the Edit Image
+links on each image page or through the drop-down menu that shows when you
+hover over an image title in the gallery browser.
+
+Snapr also hooks into the sidebar and search subsystems. You can add a block to
+your sidebar that shows a random image from Snapr's gallery by going to Edit
+The Sidebar -> Create New Block, selecting Use Code from a Plugin, and
+selecting "Random Image" from the dropdown menu. The search hook is automatic;
+whenever you perform a search, image results will be displayed on the search
+page.
+
+Obtaining support
+--------------------------------------------------
+
+Support for Snapr is available via the same support channels as Enano, as it
+is developed and maintained by the official Enano team. For support options,
+both free and commercial, please see <http://enanocms.org/Contact_us>.
+
+Have fun!
+
+-- The Enano team