X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=133a0aa2525f12178683d07fd264ce586b0f0f36;hb=63376b2a82c3f6cdf2df56b1f134bd7df0aaab3a;hp=c9cca81d776c22cdae51bee9c5747e4e5bb844f7;hpb=8a0a83a78390f22f99d4487cda2569909dfbc28e;p=fms.git

diff --git a/readme.txt b/readme.txt
index c9cca81..133a0aa 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,25 +1,26 @@
 COMPILING
 ---------
-Compiling FMS requires CMake, and pthreads.  Other required libraries are
-bundled with FMS.
+Compiling FMS requires CMake, pthreads and iconv if you want to do charset
+conversion.  Other required libraries are bundled with FMS.
 
 To compile, run these commands from the source directory:
 cmake .
 make
 
 If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON
-to the cmake command.
+to the cmake command.  To do charset conversion to UTF-8 when sending messages,
+add a -D DO_CHARSET_CONVERSION=ON.
 
 UPGRADING
 ---------
 It is always a good idea to make copies of your current FMS installation before
-continuing.  First shut down FMS and then replace the binary and template.htm
-with those from the new version.  You may keep the same database unless
-otherwise noted.
+continuing.  First shut down FMS and then replace the binary and templates with
+those from the new version.  You may keep the same database unless otherwise
+noted.
 
 INSTALLATION
 ------------
-Place the binary and template.htm in a directory of your choice.  On the first
+Place the binary and any templates in a directory of your choice.  On the first
 run, a database file will also be created in this directory.  Make sure the
 user that runs FMS has read/write access to this directory.
 
@@ -50,10 +51,13 @@ is discarded when posting messages.
 
 POSTING MESSAGES
 ----------------
-Use must set your newsreader to use UTF-8 when posting messages.  Any non-text
-attachment to the message will be stripped.  Text attachments will be inlined
-with the message body.  Cross posting is fine, but remember that each identity
-can set a limit to the number of boards each message may be cross posted to.
+You must set your newsreader to use UTF-8 when posting messages.  Any non-text
+attachment to the message will be inserted as a regular file and the key added
+to the body of the message when received.  Keep the attachments small, as the
+message can't be inserted until all attachments are inserted.  Text attachments
+will be inlined with the message body.  Cross posting is fine, but remember
+that each identity can set a limit to the number of boards each message may be
+cross posted to.
 
 CONTROL BOARDS
 --------------
@@ -72,7 +76,14 @@ template by placing an HTML file called identityname-template.htm in the same
 directory as the fms binary.  In the template, the string [LINKS] will be
 replaced by a <ul> list of links and [CONTENT] will be replaced by the page
 content.  The Freesite will be inserted once a day and contain your last 10
-posts and your trust list if you are publishing it.
+posts and your trust list if you are publishing it.  The site will be inserted
+to a USK accessible via: USK@yourpublickey.../fms/0/
+
+You may add extra files to your Freesite by creating a file called identityname-
+files.txt that contains a list of files to add to the Freesite.  There should
+be one file per line, and the path to each file may be absolute or relative to
+the working directory, but you MUST use / as the path separator.  Files cannot
+be named index.htm, trustlist.htm, or files.htm.
 
 TRUST
 -----
@@ -82,10 +93,17 @@ trust to arbitrary identities.  Pick whom you trust wisely.  The settings for
 minimum trust before downloading messages and trust lists can be changed on the
 web interface.
 
+You must have a local identity created before you can set trust levels.  Even
+if you don't want to post messages, you must still create an identity, but you
+do not have to announce it.  This way, no-one will know about that identity and
+you will be able to set trust.  If you have multiple identities, each with
+different trust levels for peers, the highest trust level set for a peer will
+determine if messages/trust lists are downloaded from them.
+
 A note on NULL trust:  If you neither trust or distrust an identity, they will
 have NULL trust (no trust at all).  You will download messages and trust lists
-from identities with NULL peer trust as long as the local trust level is above
-your configured minimum.  You will also download messages from identities with
-NULL local message trust (the peer message trust must be NULL or > your
+from identities with NULL peer trust as long as the local trust level is at or
+above your configured minimum.  You will also download messages from identities
+with NULL local message trust (the peer message trust must be NULL or >= your
 configured minimum as well), but you will not download trust lists from
 identities with NULL local trust list trust.