Memories as at 1.3

[memories.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..5b1fc00
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+Updating from an earlier release? Read the bit at the bottom!
+
+Installing the Memories photo sharing application
+-------------------------------------------------
+
+First, Perl modules. This is the hard part. You will need:
+    Maypole (good luck)
+    Class::DBI
+    DBI
+    DBD::mysql
+    Class::DBI::mysql
+    Image::Info
+    Image::Imlib2 (requires libimlib2 and libimlib2-dev packages)
+    Time::Piece
+    Cache::Cache
+    Maypole::Plugin::Upload
+    Maypole::Plugin::Authentication::UserSessionCookie
+    HTML::TagCloud
+    XML::RSS
+
+Apache mod_perl is recommended. Memories can also be run as a CGI
+application, but you're on your own.
+
+You will also need a MySQL database. Again, in theory other databases
+can be used, but in practice, you're on your own again.
+
+Configure /etc/memories/Config.pm to your site, and follow the instructions in
+there - it will require you to set other things up as well.
+
+Test that everything works:
+
+    perl -MMemories -e1
+
+If this produces no errors, you're good to configure Apache. I have
+Memories living in "/home/simon/maypole-sites/memories", and my photo
+storage in "/opt/store/", and so my configuration looks like this:
+
+    <Perl>
+        use lib qw( /home/simon/maypole-sites/memories/ );
+    </Perl>
+
+    PerlModule Memories
+    Alias /memories/static/ /home/simon/maypole-sites/memories/templates/static/
+    Alias /memories/store/ /opt/store/
+
+    <Location /memories>
+        PerlHandler Memories
+        SetHandler perl-script
+    </Location>
+
+Restart Apache, register yourself and get uploading!
+
+
+Updating Memories 1.0 to 1.1
+----------------------------
+
+1) Create the system_tags and system_taggings table as in memories.sql
+
+2) Run the tag_dates script.
+
+Updating Memories 1.1 to 1.2
+----------------------------
+
+No changes.