From fe5bcf670d8fff42f1b7880ec6250f3adb627683 Mon Sep 17 00:00:00 2001 From: Neale Pickett Date: Fri, 30 Jan 2015 19:17:16 -0700 Subject: [PATCH] touch up INSTALL --- INSTALL.txt => INSTALL | 3 +++ README | 7 ++++--- 2 files changed, 7 insertions(+), 3 deletions(-) rename INSTALL.txt => INSTALL (96%) diff --git a/INSTALL.txt b/INSTALL similarity index 96% rename from INSTALL.txt rename to INSTALL index ea67aa6..fb6dc63 100644 --- a/INSTALL.txt +++ b/INSTALL @@ -58,6 +58,7 @@ Spongy CGI Configuration If you'd like to run `spongy.cgi`, that's fine, but you have to create a configuration file +called `spongy.cfg` in the same directory as the CGI. It looks like this: @@ -66,6 +67,8 @@ It looks like this: "basedir": "/home/neale/lib/irc" } +`basedir` is the path to the BASE DIRECTORY from above. + `auth` is a sha256 checksum of your password. You can generate it for the password "bloop" like this: diff --git a/README b/README index 617cba6..f7f9cca 100644 --- a/README +++ b/README @@ -23,7 +23,8 @@ Features * Gracefully handles clients with transient networking, such as cell phones and laptops. -Todo ------ +Other Documentation +------------------- -[Todo list](TODO) +* [Installation Instructions](INSTALL) +* [Todo list](TODO)