version 0.3.33
[fms.git] / readme.txt
index caaf69d..98cc111 100644 (file)
@@ -7,29 +7,35 @@ To compile, run these commands from the source directory:
 cmake -D I_HAVE_READ_THE_README=ON .\r
 make\r
 \r
-If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON\r
-to the cmake command.  Use of the bundled SQLite3 library is on by default when\r
-compiling on a Mac.  To turn off charset conversion to UTF-8 when sending\r
-messages, add a -D DO_CHARSET_CONVERSION=OFF.  Compiling with charset\r
-conversion turned on is recommended.  If you would like to compile using the\r
-alternate captchas, add a -D ALTERNATE_CAPTCHA=ON to the cmake command line.\r
-This option requires the FreeImage library to be installed.\r
+Compiling with the bundled SQLite library is on by default.  If you do not want\r
+to use the bundled SQLite library, add a -D USE_BUNDLED_SQLITE=OFF to the cmake\r
+command.  To turn off charset conversion to UTF-8 when sending messages, add a\r
+-D DO_CHARSET_CONVERSION=OFF.  Compiling with charset conversion turned on is\r
+recommended.  If you would like to compile using the alternate captchas, add a\r
+-D ALTERNATE_CAPTCHA=ON to the cmake command line. This option requires the\r
+FreeImage library to be installed.\r
+\r
+Query logging may be turned on by adding a -D QUERY_LOG=ON.  This will create a\r
+file called query.log in the working directory.  Straight SQL statements will\r
+be captured, as well as the setup of prepared statements.  Each step through a\r
+prepared statement is also logged, but the details are not, so there should be\r
+no sensitive information in this log file.\r
 \r
 UPGRADING\r
 ---------\r
-It is always a good idea to make a copy of your current FMS installation before\r
-continuing.  First shut down FMS, make a copy of the directory, and then\r
-replace all files except the database with those from the new version.  You may\r
-keep the same database unless otherwise noted in the release information.\r
+*ALWAYS* make a copy of your current FMS installation before continuing.  First\r
+shut down FMS, make a copy of the directory, and then replace all files except\r
+the database with those from the new version.  You may keep the same database\r
+unless otherwise noted in the release information.\r
 \r
 INSTALLATION\r
 ------------\r
-Place the binary, any templates, and the fonts directory in a directory of your\r
-choice.  Windows users may need to download the runtime DLLs available from the\r
-fms Freesite and place in the fms directory if they are not already installed\r
-on the system.  On the first run, a database file will also be created in this\r
-directory.  Make sure the user that runs FMS has read/write access to this\r
-directory.\r
+Place the binary, any templates, and the fonts and images directories in a\r
+directory of your choice.  Windows users may need to download the runtime DLLs\r
+available from the fms Freesite and place in the fms directory if they are not\r
+already installed on the system.  On the first run, a database file will also\r
+be created in this directory.  Make sure the user that runs FMS has read/write\r
+access to this directory.\r
 \r
 RUNNING\r
 -------\r
@@ -42,6 +48,11 @@ argument when installing the service to set the service name to whatever you
 want.  You will need to manually start the service unless you change the\r
 startup type in the service properties.\r
 \r
+FMS must run a good portion of the day every day to work properly.  The slower\r
+your Freenet connection is, the longer FMS must be run to find the\r
+communications of other identities.  You will not have a good experience only\r
+running FMS a few hours a day.\r
+\r
 If you are experiencing a problem with FMS that you can't solve, and you've\r
 already rebooted your machine, restarted FMS, and have reproduced the problem\r
 with a brand new database, follow these instructions.  Set the logging option\r
@@ -64,6 +75,8 @@ WEB INTERFACE
 -------------\r
 By default, a web interface for administration will be running at http://\r
 localhost:8080.  You can use the interface to configure and administer FMS.\r
+There is also a forum built into the web interface so you can read and send\r
+messages without needing to use a newsreader.\r
 \r
 NNTP CONFIGURATION\r
 ------------------\r