version 0.3.25
[fms.git] / readme.txt
index 3df7b4b..4968c47 100644 (file)
@@ -11,22 +11,25 @@ If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON
 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.\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
 \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.\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 and any templates in a directory of your choice.  Windows\r
-users may need to download the runtime DLLs available from the fms Freesite and\r
-place in the fms directory if they are not already installed on the system.  On\r
-the first run, a database file will also be created in this directory.  Make\r
-sure the user that runs FMS has read/write access to this 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,13 +45,14 @@ startup type in the service properties.
 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
-to trace and restart FMS.  Create a post on the fms group that contains the\r
-operating system you are using, along with a description of the problem, what\r
-you have tried already, if you are using a precompiled binary, the startup\r
-lines from the log file as well as the portion that corresponds to the problem\r
-you are experiencing, and any other information you have that pertains to the\r
-problem.  Make sure to anonymize any IP addresses, host names, subnet masks,\r
-and keys from the log that you don't want people to know about.\r
+to trace and restart FMS.  Create a post on the fms group with a descriptive\r
+subject and a body that contains the operating system you are using, along with\r
+a description of the problem, what you have tried already, if you are using a\r
+precompiled binary, the startup lines from the log file as well as the portion\r
+that corresponds to the problem you are experiencing, and any other information\r
+you have that pertains to the problem.  Make sure to anonymize any IP addresses,\r
+host names, subnet masks, and keys from the log that you don't want people to\r
+know about.\r
 \r
 EXITING\r
 -------\r
@@ -60,6 +64,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
@@ -71,13 +77,16 @@ is discarded when posting messages.
 \r
 POSTING MESSAGES\r
 ----------------\r
-You must set your newsreader to use UTF-8 when posting messages.  Any non-text\r
-attachment to the message will be inserted as a regular file and the key added\r
-to the body of the message when received.  Keep the attachments small, as the\r
-message can't be inserted until all attachments are inserted.  Text attachments\r
-will be inlined with the message body.  Cross posting is fine, but remember\r
-that each identity can set a limit to the number of boards each message may be\r
-cross posted to.\r
+You must set your newsreader to use UTF-8 when posting messages unless you have\r
+compiled with charset conversion turned on.  All headers of the message that\r
+aren't needed will be stripped and all headers necessary for the proper sending\r
+of the message will be replaced with sanitized ones.  Any non-text attachment\r
+to the message will be inserted as a regular file and the key added to the body\r
+of the message when received.  Keep the attachments small, as the message can't\r
+be inserted until all attachments are inserted.  Text attachments will be\r
+inlined with the message body.  Cross posting is fine, but remember that each\r
+identity can set a limit to the number of boards each message may be cross\r
+posted to.\r
 \r
 CONTROL BOARDS\r
 --------------\r