X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fchatty;a=blobdiff_plain;f=doc%2FREADME.pod;fp=doc%2FREADME.pod;h=cd251213a1f982ded8cb58250b358eb85d44fa7d;hp=0000000000000000000000000000000000000000;hb=c89636c5063ea0bac876bf56248c97ade994cf8c;hpb=e26179af9aaf7cae5a0aa68ad87a50e4b1e1aba5
diff --git a/doc/README.pod b/doc/README.pod
new file mode 100644
index 0000000..cd25121
--- /dev/null
+++ b/doc/README.pod
@@ -0,0 +1,82 @@
+
+=head1 NAME
+
+Chatty -- Real-time (comet) chat application using Catalyst
+
+=head1 SYNOPSIS
+
+ # install perl dependencies; skip to the next set of instructions
+ # while the dependencies are installing
+ cpan Catalyst::Devel
+ perl Makefile.PL
+ make installdeps
+
+ # install nginx (or install and configure some other reverse proxy)
+ # configure nginx and run it
+ sudo cp extra/nginx.conf /etc/nginx/nginx.conf
+ sudo /etc/rc.d/nginx start
+
+ # configure the comet server (see L)
+ sudo cp extra/cometd/meteord.conf.dist /etc/meteord.conf
+ # add the 'SubscriberDocumentRoot' option to meteord.conf;
+ # it should be set to $REPOSITORY_ROOT/extra/cometd/public_html
+ # run meteord (in another terminal)
+ ./extra/cometd/meteord -d
+
+ # configure hostnames
+ sudo cat extra/hosts >>/etc/hosts
+
+ # create the user database
+ sqlite3 db/info.db )
+ # then,
+ eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)
+
+It is also usually much nicer to work with cpanminus rather than plain old
+cpan:
+
+ # install cpanminus
+ curl -L http://cpanmin.us | perl - --self-upgrade
+
+=head1 BUGS
+
+Tests are sadly nonexistent. :-(
+
+=head1 AUTHOR
+
+Charles McGarvey Echazmcgarvey at brokenzipper.comE
+
+=head1 LICENSE
+
+This library is free software. You can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
+