fix some inaccuracies in the documentation

[chaz/chatty] / doc / README.pod

diff --git a/doc/README.pod b/doc/README.pod
index cd251213a1f982ded8cb58250b358eb85d44fa7d..d4007f51ee6b69c833e3ef9735aa1ae5a6030eba 100644 (file)
--- a/doc/README.pod
+++ b/doc/README.pod
@@ -1,37 +1,29 @@
 
 =head1 NAME
 
-Chatty -- Real-time (comet) chat application using Catalyst
+Chatty -- Real-time (comet) chat application written with Perl/Catalyst
 
 =head1 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<http://meteorserver.org/>)
-    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 <db/schema.sql
+    cat extra/hosts >>/etc/hosts            # configure hostnames
+    sqlite3 db/info.db <db/schema.sql       # create the user database
 
-    # finally, run the application and try it out
-    ./script/chatty_server.pl -f
-    firefox http://chatty.com/
+    ./script/chatty_server.pl -f            # run the app
+    firefox http://chatty.com/              # finally, see if it works
 
 =head1 DESCRIPTION