X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;f=README;fp=README;h=2a30526070ba42979a16d8cc80696a829b73f388;hb=05b5135c2b3d5b658704029010909b651c767a3f;hp=c60cc4ff6b34dc8324d1fef6eb290149dc2a985a;hpb=57f9bfbe0bd9f89a602c5f16bff100af84ae7f83;p=chaz%2Fchatty
diff --git a/README b/README
index c60cc4f..2a30526 100644
--- a/README
+++ b/README
@@ -1,34 +1,26 @@
NAME
- Chatty -- Real-time (comet) chat application using Catalyst
+ Chatty -- Real-time (comet) chat application written with Perl/Catalyst
SYNOPSIS
- # install perl dependencies; skip to the next set of instructions
- # while the dependencies are installing
- cpan Catalyst::Devel
+ cpan Catalyst::Devel # install Catalyst
+
perl Makefile.PL
- make installdeps
+ make installdeps # install other dependencies
- # 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
+ cp extra/nginx.conf /etc/nginx/nginx.conf
+ /etc/rc.d/nginx start # run nginx http server
- # configure the comet server (see L)
- sudo cp extra/cometd/meteord.conf.dist /etc/meteord.conf
- # add the 'SubscriberDocumentRoot' option to meteord.conf;
+ cp extra/cometd/meteord.conf.dist /etc/meteord.conf
+ # also 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
+ cd extra/cometd; ./meteord -d # run meteord in a new shell
- # create the user database
- sqlite3 db/info.db >/etc/hosts # configure hostnames
+ sqlite3 db/info.db