X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fchatty;a=blobdiff_plain;f=README;fp=README;h=c60cc4ff6b34dc8324d1fef6eb290149dc2a985a;hp=0000000000000000000000000000000000000000;hb=c89636c5063ea0bac876bf56248c97ade994cf8c;hpb=e26179af9aaf7cae5a0aa68ad87a50e4b1e1aba5
diff --git a/README b/README
new file mode 100644
index 0000000..c60cc4f
--- /dev/null
+++ b/README
@@ -0,0 +1,73 @@
+NAME
+ Chatty -- Real-time (comet) chat application using Catalyst
+
+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
+
+BUGS
+ Tests are sadly nonexistent. :-(
+
+AUTHOR
+ Charles McGarvey
+
+LICENSE
+ This library is free software. You can redistribute it and/or modify it
+ under the same terms as Perl itself.
+