X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=133a0aa2525f12178683d07fd264ce586b0f0f36;hb=63376b2a82c3f6cdf2df56b1f134bd7df0aaab3a;hp=4cbc6d9cfa60d0bb0ace9d7410779172fb732e22;hpb=175f098e7e712b839db433b93fe8649a402c6784;p=fms.git diff --git a/readme.txt b/readme.txt index 4cbc6d9..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. @@ -48,12 +49,15 @@ interface to create an identity and use the name of the identity as the username for the newsgroup account. The email address may be anything, as it is discarded when posting messages. -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 -------------- @@ -64,6 +68,23 @@ settings for the board. You may cross post to a regular board and a control board with the same message. The control boards will be stripped from the message before inserting into Freenet. +FREESITES +--------- +Each identity has the option to publish a freesite. A generic HTML template +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