X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=420fdf102256e66e2b5adbd7c33db4d8def1e3a3;hb=853f67b0b7b8121d572cff34d40f7b28cac8f65e;hp=593a99f14e07361bf2837443fbf08a9e3c33eb0a;hpb=107bd97018964d48425306026d06afd038e84db0;p=fms.git diff --git a/readme.txt b/readme.txt index 593a99f..420fdf1 100644 --- a/readme.txt +++ b/readme.txt @@ -1,14 +1,15 @@ 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 --------- @@ -19,9 +20,11 @@ noted. INSTALLATION ------------ -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. +Place the binary and any templates in a directory of your choice. Windows +users may need to download the runtime DLLs available from the fms Freesite and +place in the fms directory if they are not already installed on the system. 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. RUNNING ------- @@ -50,10 +53,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 -------------- @@ -71,9 +77,16 @@ called site-template.htm is used to insert the site. You can customize the 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